KVHTMLOptionsEx
This structure defines the options that control the HTML markup written in response to the general style and attributes (font, color, and so on) of the document. A pointer to this structure is passed as an argument to the function fpConvertStream()
or KVHTMLConvertFile()
.
typedef struct tag_KVHTMLOptionsEx { KVCharSet OutputCharSet; BOOL bUseDocumentColors; BOOL bUseDocumentFontInfo; BOOL bSupportFontFace; BOOL bSupportUserFontSizeMapping; KVFontSizeMap FontSizeMap; BOOL bDisplayRelativeFontSize; BOOL bSupportRFC1942_cols; BOOL bNbspEmptyCells; ENSATableBorder SATableBorder; int nTableBorderWidth; char *pszBaseURL; char *pszMainURL; char *pszDefaultOutputDirectory; char *pszPicPath; char *pszPicURL; char *pszJavaURL; char *pszJavaArchive; BOOL bRemoveFileNameSpaces; BOOL bRasterizeFiles KVHTMLGraphicType OutputRasterGraphicType; KVHTMLGraphicType OutputVectorGraphicType; int cxVectorToRasterXRes; int cyVectorToRasterYRes; BOOL bGenerateURLs; long lcbMaxMemUsage; BOOL bSupportColumnHeadings; BOOL bSupportRowHeadings; BOOL bSupportCellSpan; BOOL bSupportRowSpan; BOOL bSupportColumnWidth; BOOL bRemoveEmptyColumns; BOOL bRemoveEmptyRows; int nRowsBeforeSplit; KVLanguageID OutputLanguageID; KVHTMLStyleSheetType eStyleSheetType BOOL bTabsToTables; BOOL bForceOutputCharSet; BOOL bEnableEmptyRows; BYTE cReplaceChar; BYTE cRedact; KVCharSet eSrcCharSet; BOOL bForceSrcCharSet; int nCompressionQuality; } KVHTMLOptionsEx;
Member Descriptions
The character set to use for textual output. The available character sets are enumerated in To make sure that the character set defined here is used, you must set The default is |
|
Set The default is |
|
Set The default is |
|
Set This applies only when you set |
|
Set This applies only when you set |
|
The font sizes to which the HTML tags See the Discussion section for more information. |
|
Set The default is |
|
Set The default is |
|
Set This option applies to word processing documents and spreadsheets only. The default is |
|
Specifies whether table borders are based on the setting in the source document, are always on, or are always off. The options are enumerated in This option applies to word processing documents only. The default is |
|
Sets the width of the table border in pixels. This option applies to word processing documents only. The default is |
|
The base URL that replaces the The default is |
|
The URL that replaces the The default is |
|
The default output directory for auxiliary files created during the conversion. The default is |
|
The output directory for graphics created during the conversion. If specified, this member can also be used by the callback functions This option applies to word processing documents only. The default is |
|
The URL of the picture files created from embedded graphics in the source document. To specify a complete image source, this element must be combined with p For example, setting
This element applies to word processing documents only. The default is |
|
Set The default is |
|
Set Set The default is NOTE: When |
|
The output format of rasterized embedded graphics. The options are enumerated in KVHTMLGraphicType in |
|
The output format of vector graphics. The options are enumerated in KVHTMLGraphicType in If you turn on highlighting by using |
|
Specifies the horizontal resolution when converting presentation files and vector graphics. This is set in conjunction with The default value is |
|
Specifies the vertical resolution when converting presentation files and vector graphics. This is set in conjunction with The default value is |
|
Set This option applies to word processing documents only. The default is |
|
The maximum memory allocated dynamically for token buffers during file processing. If this maximum is reached, Export performs a swap-to-disk operation internally, and then reuses the memory blocks. Export maintains an internal minimum memory size. This option applies to word processing or text documents only. The default is |
|
Set This option applies to spreadsheets only. The default is |
|
Set This option applies to spreadsheets only. The default is |
|
Set This option applies to spreadsheets only. The default value is |
|
Set This option applies to spreadsheets only. The default value is |
|
Set This option applies to spreadsheets only. The default value is |
|
Set This option applies to spreadsheets only. The default is |
|
Set The default is |
|
The approximate number of spreadsheet rows to be processed before splitting a table. This helps to prevent large spreadsheet tables from occurring in a single document, which can cause speed and processing problems for the browser. This option applies to spreadsheets only. The default is |
|
The language for the textual output of language-specific data such as time and date. The default is |
|
|
One of the enumerated options for processing style sheet information. The options are defined in KVHTMLStyleSheetType in
The default is |
Set When you use The default is |
|
Set The default is |
|
Set This option applies to spreadsheets only. The default is |
|
The character used when a character in the source document's character set cannot be mapped to the output character set. The default replacement character is a question mark ( |
|
The character used to replace text that is designated through style mapping to be omitted from the output. This functionality is useful when you need to hide confidential or sensitive information. The specified character is used for all text that is mapped to a style processed with the This option applies to word processing documents only. The default replacement character is "X". |
|
Specifies the source character set of the document. The available character sets are enumerated in To make sure that the character set defined here is used, you must set The default is |
|
Set Forcing a character set to The default is |
|
Controls the output quality of graphics that support compression quality (for example, JPEG). A value of This option applies to word processing documents only. The default is |
|
This member is only available in the structure in the template files. It is not part of the structure in the API. If you set NOTE: If you want to use CSS files, you must set If you set This member is passed to the bIndex argument of the The default is |
Discussion
-
A pointer to this structure is passed as an argument to
fpConvertStream()
orKVHTMLConvertFile()
. If the pointer to the structure is notNULL
, the values of the members specified in the structure are used. If the pointer to the structure isNULL
, the default values are used. -
bNoPictures
is similar to theKVCFG_BLANKPICTURE
flag in the call toKVHTMLConfig()
. UnlikebNoPictures
, theKVCFG_BLANKPICTURE
flag generates image tags with an emptysrc
attribute. KVHTMLConfig(). -
To output graphics for presentations, you must set
bNoPictures
toFALSE
, and set bRasterizeFiles toTRUE
. -
The values in FontSizeMap indicate the range for the HTML tag
<font size=#>
. For example, if you specify8
,10
,12
,14
,18
, and24
:-
font size <= 8 in the source document is mapped to
<font size=1>
in the output HTML -
else, font size <=10 in the source document is mapped to
<font size=2>
in the output HTML -
else, font size <=12 in the source document is mapped to
<font size=3>
in the output HTML -
else, font size <=14 in the source document is mapped to
<font size=4>
in the output HTML -
else, font size <=18 in the source document is mapped to
<font size=5>
in the output HTML -
else, font size <=24 in the source document is mapped to
<font size=6>
in the output HTML -
font size >24 in source the document is mapped to
<font size=7>
in the output HTML
-
When the HTML output is viewed, the browser maps <font size=
#
>
to a specific font size.
Set the Resolution of Presentations and Vector Graphics
The cxVectorToRasterXRes and cyVectorToRasterYRes members are set in conjunction to specify the resolution (width and height) at which presentation files and vector graphics are converted.
You can specify the resolution as an absolute size in pixels, or as a proportion of the original size.
KeyView always maintains the aspect ratio of the original graphic and does not increase the resolution. If you set values that would enlarge a graphic, KeyView only changes the size of the HTML element.
To set the resolution in pixels
To specify the resolution in pixels, specify the width (cxVectorToRasterXRes
) and/or height (cyVectorToRasterYRes
).
To export the largest image that fits within a bounding box, without changing the original aspect ratio, set both the width and height. For example, to export the largest image that fits in an 800x500 bounding box:
cxVectorToRasterXRes=800 cyVextorToRasterYRes=500
Alternatively you can fix one of the dimensions. Set one value and set the other to zero. For example, to export images with a height of 1500 pixels and whatever width is necessary to maintain the original aspect ratio:
cxVectorToRasterXRes=0 cyVextorToRasterYRes=1500
The maximum size permitted for either dimension is 4000 pixels.
To set the resolution proportionally
To set the resolution proportionally, set cxVectorToRasterXRes
to a negative value. A negative value represents a percentage of the original resolution. Set cyVectorToRasterYRes
to 0
(zero). Negative (percentage) values for
cyVectorToRasterYRes
are ignored.
The following example exports a graphic at 50 percent of its original resolution:
cxVectorToRasterXRes=-50 cyVectorToRasterYRes=0