typedef struct _DOCWRTHTMOPTIONS
} DOCWRTHTMOPTIONS, *pDOCWRTHTMOPTIONS;
The DOCWRTHTMOPTIONS structure provides information about HTML files.
Options structure that contains options for HTML format.
Value that indicates the HTML document type. Possible values are:
|DOCWRTHTMTYPE_IECOMPATIBLE|| The created document is compatible with Internet Explorer (IE5 and above)|
|DOCWRTHTMTYPE_NETSCAPEOMPATIBLE|| The created document is compatible with Internet Explorer and Netscape|
|DOCWRTHTMTYPE_IENETSCAPEOMPATIBLE|| The created document is compatible with Netscape|
Value that indicates the font embedding mode to use when creating an HTML document. Possible values are:
|DOCWRTFONTEMBED_NOEMBED|| Do not embed fonts.|
|DOCWRTFONTEMBED_AUTO|| Embed fonts that are not commonly available with the exception of Licensed Fonts. This is the default value.|
|DOCWRTFONTEMBED_FORCE|| Embed fonts that are not commonly available with Licensed Fonts.|
|DOCWRTFONTEMBED_ALL|| Embed all fonts, including the Licensed Fonts with the document.|
Flag that indicates whether to use the
rgbBackground color. Possible values are:
|FALSE||Do not use
Value that specifies the background color of the HTML document. Use only if
bUseBackgroundColor is TRUE.
Flag that indicates the extra options for writing HTML files. Currently there are no flags. This is for future use.
Value that specifies the image format to use for embedded images. Can be either FILE_PNG or FILE_JPEG.
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.
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.
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.
Flags that indicate the type (format) of the fonts to use. This value can be a combination of one or more of the following:
|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|
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.
uFontFlagscan be used to control the type of format to use when saving fonts in the HTML document. The default value of
DOCWRT_FONT_FLAGS_WOFF1ensures 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.
uFontFlagsis used only when the value of
bEmbedFontsis set to
The LEADTOOLS Document Writers support creating HTML documents. The following features are supported:
The structure is used by:
Medical Web Viewer .NET
.NET, Java, Android, and iOS/macOS Assemblies
C API/C++ Class Libraries