LEADTOOLS Raster Imaging C DLL Help > LEADTOOLS Raster Imaging Features > Document Writers > Used Structures > docwrthtmoptions |
typedef struct _DOCWRTHTMOPTIONS
{
DOCWRTOPTIONS Options;
DOCWRTHTMTYPE Type;
DOCWRTFONTEMBED FontEmbed;
L_BOOL bUseBackgroundColor;
COLORREF rgbBackground;
L_UINT32 uFlags;
} DOCWRTHTMOPTIONS, *pDOCWRTHTMOPTIONS;
The DOCWRTHTMOPTIONS structure provides information about HTML files.
Member |
Description |
|
Options |
Options structure that contains options for HTML format. |
|
Type |
Value that indicates the HTML document type. Possible values are: |
|
|
Value |
Meaning |
|
DOCWRTHTMTYPE_IECOMPATIBLE |
[0] The created document is compatible with Internet Explorer (IE5 and above) |
|
DOCWRTHTMTYPE_NETSCAPEOMPATIBLE |
[1] The created document is compatible with Internet Explorer and Netscape |
|
DOCWRTHTMTYPE_IENETSCAPEOMPATIBLE |
[2] The created document is compatible with Netscape |
FontEmbed |
Value that indicates the Font embedding modes. Possible values are: |
|
|
Value |
Meaning |
|
DOCWRTFONTEMBED_NOEMBED |
[0] Do not embed fonts. |
|
DOCWRTFONTEMBED_AUTO |
[1] Embed fonts that are not commonly available with the exception of Licensed Fonts. |
|
DOCWRTFONTEMBED_FORCE |
[2] Embed fonts that are not commonly available with Licensed Fonts. |
|
DOCWRTFONTEMBED_ALL |
[3] Embed all fonts, including the Licensed Fonts with the document. |
bUseBackgroundColor |
Flag that indicates whether to use the rgbBackground color. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
Use the rgbBackground color as the background color in the created HTML document. |
|
FALSE |
Do not use rgbBackground. |
rgbBackground |
Value that specifies the background color of the HTML document. Use only if bUseBackgroundColor is TRUE. |
|
uFlags |
Flag that indicates the extra options for writing HTML files. Currently there are no flags. This is for future use. |
Comments
pDOCWRTHTMOPTIONS is a pointer to DOCWRTHTMOPTIONS structure. Generally, where a function parameter type is pDOCWRTHTMOPTIONS, you can declare a DOCWRTHTMOPTIONS variable, update the structure's fields, and pass the variable's address in the parameter. Declaring a pDOCWRTHTMOPTIONS variable is necessary only if your program requires a pointer.
This structure is used with the L_DocWriterConvert and L_DocWriterInit functions.