KVXMLOptions
This structure defines the options that control the XML markup written in response to the general style and attributes (font, color, and so on) of the document. The structure is initialized by calling the fpConvertStream()
or KVXMLConvertFile()
function. See fpConvertStream() or KVXMLConvertFile().
typedef struct tag_KVXMLOptions { BOOL bUseVerityDTD; char *pszVerityDTDPath; KVXMLStyleSheetType eStyleSheetType BOOL bUseExistingStyleSheet; char *pszStyleSheet; BOOL bIndexOnly; KVCharSet eOutputCharSet; BOOL bForceOutputCharSet; KVCharSet eSrcCharSet; BOOL bForceSrcCharSet; KVLanguageID eOutputLanguageID; BOOL bUseDocumentColors; BOOL bUseDocumentFontInfo; BOOL bNbspEmptyCells; ENSATableBorder eSATableBorder; int nTableBorderWidth; char *pszBaseURL; char *pszMainURL; char *pszDefaultOutputDirectory; char *pszPicPath; char *pszPicURL; char *pszJavaURL; BOOL bRemoveFileNameSpaces; BOOL bRasterizeFiles KVXMLGraphicType eOutputRasterGraphicType; KVXMLGraphicType eOutputVectorGraphicType; int cxVectorToRasterXRes; int cyVectorToRasterYRes; int nCompressionQuality; BOOL bGenerateURLs; long lcbMaxMemUsage; BYTE cReplaceChar; BYTE cRedact; KVXMLEmptyParaType eEmptyParaType; KVXMLHardPageBreakType eHardPageBreakType; BOOL bSupportColumnHeadings; BOOL bSupportRowHeadings; BOOL bSupportCellSpan; BOOL bSupportRowSpan; BOOL bSupportColumnWidth; BOOL bRemoveEmptyColumns; BOOL bRemoveEmptyRows; BOOL bEnableEmptyRows; int nRowsBeforeSplit; } KVXMLOptions;
Member Descriptions
Set The default is |
|
If you move the Verity DTD from the default The default is no path, that is, the DTD is assumed to be in the same directory as the generated XML files. |
|
|
One of the enumerated options for processing style sheet information. The options are defined in
|
Set
If Existing style sheets are not validated. The default is |
|
The path and file name of an external style sheet. The default is no path. |
|
Set The template file named To generate output with verbose markup and without images, set the The default is |
|
|
The character set to use for textual output. To ensure that the character set defined here is used, you must set Document Readers lists the file formats for which character set information can be determined. The default is |
Set Forcing a character set to The default is |
|
This option specifies the character set of the document. To ensure that the character set defined here is used, you must set The default is |
|
Set Forcing a character set to The default is |
|
The language for the textual output of language-specific data such as time and date. The default is |
|
Set The default is |
|
Set The default is |
|
Set This option applies to word processing documents and spreadsheets only. The default is |
|
This option 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 |
|
This option sets the width of the table border in pixels. This option applies to word processing documents only. The default is 1. |
|
The base URL that replaces the The default is |
|
The main 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 graphic files 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 graphic files created from embedded graphics in the source document. To specify a complete image source, this element must be combined with For example, setting
This option applies to word processing documents only. The default is |
|
The URL where the Java rasterizer ( The Java rasterizer is not currently enabled. The default is |
|
|
Set The default is |
Set The default is NOTE: When |
|
The output format of rasterized embedded graphics. The options are enumerated in KVXMLGraphicType in |
|
The output format of vector graphics. The options are enumerated in KVXMLGraphicType in |
|
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 |
|
This option 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 |
|
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 |
|
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 that replaces tagged text that has been 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 has been mapped to a style processed with the This option applies to word processing documents only. The default replacement character is "X". |
|
This option determines if paragraphs without content generate markup or ID attributes in the output file. There are three options enumerated in This option applies to word processing documents only. The default is |
|
This option determines if hard page breaks generate markup or ID attributes in the output file. There are four options enumerated in This option applies to word processing 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 This option applies to spreadsheets only. The default is |
|
Set This option applies to spreadsheets only. 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 0. |
Discussion
A pointer to this structure is passed as an argument to fpConvertStream()
and KVXMLConvertFile()
. If the pointer to the structure is not NULL
, the values of the members specified in the structure are used. If the pointer to the structure is NULL
, the default values are used.
Set the Resolution of Presentations and Vector Graphics
The members cxVectorToRasterXRes
and cyVectorToRasterYRes
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 XML 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