In This Topic ▼

FILERTFOPTIONS

Summary

The FILERTFOPTIONS structure provides information on loading RTF files in LEADTOOLS.

Syntax

typedef struct _FILERTFOPTIONS 
{ 
   L_UINT uStructSize; 
   L_COLORREF crBackColor; 
   L_UINT uFlags; 
} FILERTFOPTIONS, * pFILERTFOPTIONS;

Members

uStructSize

Size of the structure. This must be set before passing this structure to the LEAD functions. Use sizeof(FILERTFOPTIONS).

crBackColor

The background color used when rendering RTF documents. The background color used when rendering RTF documents. Default value is "white".

uFlags

Flags for RTF files. Possible values are:

Value	Meaning
RTF_USE_MULTIPLATFORM	[0x0001] If set, use the multiplatform RTF engine. If not set, use the legacy windows-only RTF engine.
	The multiplatform engine was introduced in v20. You can get the behavior from v19 or earlier by not setting this flag.

Comments

pFILERTFOPTIONS is a pointer to a FILERTFOPTIONS structure.

Rich Text Format (RTF) files have no physical width or height in pixels. You can use RASTERIZEDOCOPTIONS to control how the final document is rendered as a raster image. For more information, refer to RASTERIZEDOCOPTIONS.

This example will clear the RTF_USE_MULTIPLATFORM and use the legacy windows RTF engine to load RTF files: 
 
FILERTFOPTIONS RTFOptions; 
if(L_GetRTFOptions(&RTFOptions, sizeof(FILERTFOPTIONS)) == SUCCESS) 
{ 
   RTFOptions.uFlags = 0; 
   L_SetRTFOptions(&RTFOptions); 
} 
/* Now if call L_LoadBitmap or L_LoadFile to load your RTF file, the RTF filter will use the legacy RTF engine */