In This Topic ▼

DOCWRTHTMOPTIONS

typedef struct _DOCWRTHTMOPTIONS 
{ 
   DOCWRTOPTIONS Options; 
   DOCWRTHTMTYPE Type; 
   DOCWRTFONTEMBED FontEmbed; 
   L_BOOL bUseBackgroundColor; 
   COLORREF rgbBackground; 
   L_UINT32 uFlags; 
   L_INT nImageFormat; 
   L_BOOL bEmbedCSS; 
   L_BOOL bEmbedImages; 
   L_BOOL bEmbedFonts; 
   L_UINT uFontFlags; 
} DOCWRTHTMOPTIONS, *pDOCWRTHTMOPTIONS;

The DOCWRTHTMOPTIONS structure provides information about HTML files.

Members

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 mode to use when creating an HTML document. 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. This is the default value.
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.

nImageFormat

Value that specifies the image format to use for embedded images. Can be either FILE_PNG or FILE_JPEG.

bEmbedCSS

Value that specifies how to save the CSS for the output file. Set this to TRUE, to embed the CSS inside the output file. Set this to FALSE to store the CSS in a separate folder from the output file.

bEmbedImages

Value that specifies how to save the images for the output file. Set this to TRUE, to embed the images inside the output file. Set this to FALSE to store the images in a separate folder from the output file.

bEmbedFonts

Value that specifies how to save the fonts for the output file. Set this to TRUE, to embed the fonts inside the output file. Set this to FALSE to store the fonts in a separate folder from the output file.

uFontFlags

Flags that indicate the type (format) of the fonts to use. This value can be a combination of one or more of the following:

Value	Meaning
DOCWRT_FONT_FLAGS_DEFAULT	[0x00] Default font type. Currently this will be similar to DOCWRT_FONT_FLAGS_WOFF1
DOCWRT_FONT_FLAGS_WOFF1	[0x01] WOFF version 1 font file format. Supported by all major browsers
DOCWRT_FONT_FLAGS_EOT	[0x02] EOF font file format. Supported by older versions of Internet Explorer
DOCWRT_FONT_FLAGS_TTF	[0x04] TTF font file format. Supported by all major browsers
DOCWRT_FONT_FLAGS_WOFF2	[0x08] WOFF version 2 font file format. Supported by some of major browsers

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.

HyperText Markup Language (HTML). HTML is the standard language used to render web page in a web browser. Support for text, tables, CSS and images is provided.

uFontFlags can be used to control the type of format to use when saving fonts in the HTML document. The default value of DOCWRT_FONT_FLAGS_WOFF1 ensures that the font can be read by all major browsers. Font types can be ORed with each other to save multiple versions in different formats of the font if desired. uFontFlags is used only when the value of bEmbedFonts is set to L_TRUE.

The LEADTOOLS Document Writers support creating HTML documents. The following features are supported: