This function is called directly and provides a way to configure options prior to document conversion. You can use this function to:
Enable PDF conversion to JPEG or PNG
Enable the graphic-based PDF readers kppdfrdr
and kppdf2rdr
to convert PDF documents to JPEG files.
Configure PDF bookmarks
Specify whether bookmarks in a PDF file are used to create a table of contents in the HTML output.
Configure rotated text
Specify whether rotated text is displayed in its original position or at the bottom of the page. Currently, this option applies only to PDF files.
Specify a directory in which temporary files created during the conversion process are stored.
NOTE: On Windows systems, there is a 64 K size limit to the temporary directory. When the limit is reached, you must either create a new directory or delete the contents of the existing directory; otherwise, you might receive an error message.
Specify the elements and attributes extracted from an XML document based on a file's document type.
Enable PDF logical reading order
Convert paragraphs in PDF files in the order in which they appear on the PDF page and with left-to-right or right-to-left paragraph direction. See Convert PDF Files to a Logical Reading Order.
Configure PDF soft hyphens
Specify whether soft hyphens in a PDF file are removed from the HTML output. See Control Hyphenation.
Convert text and graphics that were deleted from a document with revision tracking enabled and include revision information in the HTML output. See Include Revision Information.
Prevent graphics from being converted and generate image tags with empty src
attributes. This makes the conversion faster, but, because placeholders are generated for the graphics, maintains the text flow of the original document. This is similar to the bNoPictures
parameter; however, bNoPictures
does not generate an image tag. See bNoPictures.
Toggle hidden data output from Microsoft Word, Excel, and PowerPoint documents
Show or hide information from hidden sources such as comments or slides. See Show Hidden Data.
Enable a PDF invisible text toggle button
Enable a JavaScript button that toggles the display of invisible text and regular content in exported PDF documents. Toggle Invisible Text.
Specify opacity of invisible text in PDFs
Specify the opacity of invisible text in exported PDF documents, from 0 (invisible) to 100 (fully visible). See Specify Opacity of Invisible Text.
Protected file password
Specify the password to use to open a password-protected file for export.
Specify output character set for summary information
Specify the output character set for the document's metadata, when using fpGetSummaryInfo()
.
Enable tabbed spreadsheet view
Enables a tabbed navigation view for spreadsheets.
Enable previews for large spreadsheets
Limits the number of rows, columns, and sheets that are exported to HTML.
KVErrorCode pascal KVHTMLConfig( void *pContext, int nType, int nValue, void *p );
pContext
|
A pointer returned from fpInit() or fpInitWithLicenseData(). |
nType
|
The configuration flag. This is a symbolic constant defined in |
nValue
|
The integer value defined for the flags above. This is
|
p
|
The data for the configuration flag. This is
|
The return value is one of the error codes defined in KVErrorCode
in kverrorcodes.h
.
You must call this function after the call to fpInit() or fpInitWithLicenseData() and before the call to fpConvertStream()
or KVHTMLConvertFile()
.
This function runs in-process or out of process. See Convert Files Out of Process.
When converting out of process, this function must be called after the call to KVHTMLStartOOPSession()
and before the call to KVHTMLEndOOPSession()
.
The configuration flags are described in the following table.
Flag | Description |
---|---|
This flag enables the graphic-based PDF readers By default, Export uses the basic PDF reader, |
|
KVCFG_SETMETADATACHARSET
|
This flag enables you to specify the output character set for metadata when using fpGetSummaryInfo() . nValue is a character set enumerated in KVCharSet in kvcharset.h . See Convert Character Sets. You should call this function before fpGetSummaryInfo() . |
If you set |
|
If you set By default, rotated text in a file is displayed in its original position, at the original font size, and at 0 degrees rotation. Because the text is the original size, but might be displayed in a smaller space, the text might overlap adjacent text in the HTML output. You use the HTML markup does not support text rotation. |
|
This flag enables you to specify the directory in which temporary files created during conversion processes are stored. By default, the system temporary directory is used. To define a directory for temporary files generated during an out-of-process conversion, set the On Windows systems, there is a 64 K size limit to the temporary directory. When the limit is reached, you must either create a new directory or delete the contents of the existing directory; otherwise, you might receive an error message. |
|
This flag enables you to define which elements and attributes are extracted from XML documents with a specified format ID or root element. You can use this to override the default settings for the supported XML formats (see Convert XML Files), or to define settings for custom XML document types. The settings are defined in the You can also modify element extraction settings by using the |
|
This flag converts paragraphs in a PDF file in the order in which they appear on the page (logical reading order). The |
|
If you set this flag, soft hyphens in the source document are removed, and the hyphenated words are joined in the HTML output. By default, soft hyphens are maintained. See Control Hyphenation. Micro Focus recommends that you remove soft hyphens if you use Export to generate text output for an indexing engine or are not concerned with maintaining the document's layout. See fpConvertStream() or KVHTMLConvertFile() for more information on running Export in index mode. |
|
If you set this flag to To reset the flag and exclude deleted content and revision information from the HTML output, set the flag to The default is |
|
If you set this flag to
This allows you to generate output without graphics, but still maintain the text flow of the original document. This option applies to word processing formats only. The default is |
|
Set this flag to You can also toggle the display of comment output by modifying the |
|
Set this flag to |
|
Set this flag to |
|
Set this flag to |
|
Set this flag to |
|
Set this flag to |
|
Set this flag to |
|
Set this flag to |
|
Set this flag to |
|
Set this flag to |
|
Set this flag to You can also toggle slide note output by modifying the |
|
|
This flag enables a JavaScript button in exported PDF documents, which you can use to show and hide invisible text. Invisible text is hidden by default. See Toggle Invisible Text. |
|
This flag allows you specify the degree of invisible text opacity in exported PDFs, from Invisible text opacity is set to |
This flag enables you to define a password used to open a password-protected file for export. See Export Password Protected Files. For a list of supported file types, see Supported Password Protected File Types.
|
|
KVCFG_TABNAVIGATION
|
If you set this flag to NOTE: JavaScript must be enabled. |
KVCFG_SS_PREVIEW
|
Specifies whether to export a preview for large spreadsheets rather than exporting all content. Web browsers might take a long time, or fail completely, to render spreadsheets with large numbers of cells. If you set this flag to TRUE , KeyView limits the numbers of rows, columns, and sheets that are exported to HTML. |
To specify that the graphic-based PDF reader is used to convert PDF files:
(*fpHTMLConfig)(pKVHTML, KVCFG_SETHIFIPDF, TRUE, NULL);
To specify that bookmarks in a PDF file are not used to generate a table of contents in the HTML output:
(*fpHTMLConfig)(pKVHTML, KVCFG_SUPPRESSTOCPRINTIMAGE, TRUE, NULL);
To specify that rotated text in a file is displayed at 0 degrees at the bottom of the page on which it appears:
(*fpHTMLConfig)(pKVHTML, KVCFG_SETTEXTROTATE, TRUE, NULL);
To set a directory for temporary files:
char tmpDir[250]; strcpy (tmpDir, "c:\\temp\\htmlexport"); (*fpHTMLConfig)(pKVHTML, KVCFG_SETTEMPDIRECTORY, 0, tmpDir);
To specify custom extraction settings for conversion of an XML file:
KVXConfigInfo xinfo; (*fpHTMLConfig)(pKVHTML, KVCFG_SETXMLCONFIGINFO, 0, &xinfo);
To specify that PDF files are converted to a logical reading order, and the paragraph direction for the PDF output is left to right:
(*fpHTMLConfig)(pKVHTML, KVCFG_LOGICALPDF, LPDF_LTR, NULL);
To specify that PDF files are converted to a logical reading order, and the paragraph direction for the PDF output is right to left:
(*fpHTMLConfig)(pKVHTML, KVCFG_LOGICALPDF, LPDF_RTL, NULL);
To specify that PDF files are converted to a logical reading order, and the paragraph direction for the PDF output is determined automatically for each page:
(*fpHTMLConfig)(pKVHTML, KVCFG_LOGICALPDF, LPDF_AUTO, NULL);
To specify that soft hyphens are removed from the HTML output:
(*fpHTMLConfig)(pKVHTML, KVCFG_DELSOFTHYPHEN, TRUE
, NULL);
To convert text and graphics that are identified by revision marks:
KVRevisionMark RMark; (*fpHTMLConfig)(pKVHTML, KVCFG_INCLREVISIONMARK, TRUE, &RMark))
To generate a placeholder for all pictures:
(*fpHTMLConfig)(pKVHTML, KVCFG_BLANKPICTURE, TRUE, NULL);
To toggle hidden data output from Microsoft Word documents, use one of the KVCFG_WP
flags:
(*fpHTMLConfig)(pKVHTML, KVCFG_WP_NOCOMMENTS, TRUE, NULL);
To toggle hidden data output from Microsoft Excel documents, use one of the KVCFG_SS
flags:
(*fpHTMLConfig)(pKVHTML, KVCFG_SS_SHOWHIDDENINFOR, TRUE, NULL);
To toggle hidden data output from Microsoft PowerPoint documents, use one of the KVCFG_PG
flags:
(*fpHTMLConfig)(pKVHTML, KVCFG_PG_HIDEHIDDENSLIDE, TRUE, NULL);
To enable an invisible text toggle button in exported PDF documents:
(*fpHTMLConfig)(pKVHTML, KVCFG_SETPDFINVISTEXTTOGGLE, 0, szButtonName);
where szButtonName
is a null-terminated string that determines the button name.
To specify the opacity of invisible text in exported PDF documents:
(*fpHTMLConfig)(pKVHTML, KVCFG_SETPDFINVISTEXTOPACITY, iInvisOpacity, NULL);
where iInvisOpacity
is an integer from 0 (invisible) to 100 (fully visible).
To specify a password to open a password-protected file for export:
(*fpHTMLConfig)(pKVHTML, KVCFG_SETPASSWORD, TRUE, password);
where password
is a null-terminated string of 255 or fewer characters.
To produce summary information in UTF8:
(*fpHTMLConfig)(pKVHTML, KVCFG_SETMETADATACHARSET, KVCS_UTF8, NULL);
To export only a preview of spreadsheets to HTML:
(*fpHTMLConfig)(pKVHTML, KVCFG_SS_PREVIEW, TRUE, NULL);
|