TEXTFORMATTEDSETTINGS

typedef struct _tagTextFormattedSettings 
{ 
   L_UINT32 uStructSize; 
   DOC2_CODEPAGESETTING CpSetng; 
   L_WCHAR * pszLineBreak; 
   L_BOOL bLineBreaks; 
   L_BOOL bPageBreaks; 
   L_BOOL bPageMargins; 
} TEXTFORMATTEDSETTINGS, * pTEXTFORMATTEDSETTINGS; 

The TEXTFORMATTEDSETTINGS structure provides information about settings for the DOC2_FORMATTED_TEXT DOC2_FORMATTYPE output format.

Members

uStructSize

Structure size. Set it to sizeof(TEXTFORMATTEDSETTINGS).

CpSetng

Specifies the code page. For a list of possible values, refer to DOC2_CODEPAGESETTING

pszLineBreak

Unicode character string that contains the characters to use when inserting Line breaks.

The toolkit allocates memory internally for this member using the Windows GlobalAllocPtr macro. When the structure is no longer needed, be sure to use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

bLineBreaks

Specifies whether to insert line breaks.

Value Meaning
TRUE Insert line breaks.
FALSE Do not insert line breaks.

bPageBreaks

Specifies whether to use page breaks. Possible values are:

Value Meaning
TRUE Use page breaks.
FALSE Do not use page breaks.

bPageMargins

Specifies whether to retain page margins or use default margins. Possible values are:

Value Meaning
TRUE Retain page margins.
FALSE Use default margins.

Comments

pTEXTFORMATTEDSETTINGS is a pointer to a TEXTFORMATTEDSETTINGS structure. If the function parameter type is pTEXTFORMATTEDSETTINGS, declare a TEXTFORMATTEDSETTINGS variable, update the structure's fields, and pass the variable's address in the parameter. Declaring a pTEXTFORMATTEDSETTINGS variable is necessary only if the program requires a pointer.

The structure is used by:

Help Version 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS OCR Module - OmniPage Engine C API Help