typedef struct _tagRtfDocWordMLSettings
{
L_UINT32 uStructSize;
L_BOOL bBullets;
L_BOOL bCharColors;
L_BOOL bCharScaling;
L_BOOL bCharSpacing;
L_BOOL bColumnBreaks;
L_BOOL bConsolidatePages;
L_CHAR * pszDocAuthor;
L_CHAR * pszDocCategory;
L_CHAR * pszDocComments;
L_CHAR * pszDocCompany;
L_CHAR * pszDocKeywords;
L_CHAR * pszDocManager;
L_CHAR * pszDocSubject;
L_CHAR * pszDocTitle;
L_BOOL bDropCaps;
L_BOOL bFieldCodes;
DOC2_HEADERFOOTERSETTING HFSetng;
L_BOOL bLineBreaks;
DOC2_FORMATLEVEL OutputMode;
DOC2_PAGEBREAKSETTING PgBreakValue;
L_BOOL bPageColor;
DOC2_DPISETTING DpiSetng;
L_BOOL bRuleLines;
L_BOOL bStyles;
DOC2_TABLESETTING TableSetng;
L_BOOL bTabs;
} RTFDOCWORDMLSETTINGS, * pRTFDOCWORDMLSETTINGS;
The RTFDOCWORDMLSETTINGS structure provides information for the common settings of the following output formats:
DOC2_RTF_6
DOC2_RTF_97
DOC2_RTF_2000
DOC2_RTF_WORD_2000
DOC2_WORD_2000
DOC2_WORD_97
DOC2_WORDML
Member | Description | |
uStructSize | Structure size. It should be equal to size of(RTFDOCWORDMLSETTINGS). | |
bBullets | Specifies whether bullets are in the document. Possible values are: | |
Value | Meaning | |
TRUE | Bullets are in the document. | |
FALSE | Bullets are not in the document. | |
bCharColors | Specifies whether the colors of the characters should be kept. Possible values are: | |
Value | Meaning | |
TRUE | Keep the font colors of the characters. | |
FALSE | Do not keep the font colors of the characters. | |
bCharScaling | Specifies whether to keep character scaling. Possible values are: | |
Value | Meaning | |
TRUE | Keep character scaling. | |
FALSE | Do not keep character scaling. | |
bCharSpacing | Specifies whether to keep character spacing. Possible values are: | |
Value | Meaning | |
TRUE | Keep character spacing. | |
FALSE | Do not keep character spacing. | |
bColumnBreaks | Specifies whether to keep column breaks. Possible values are: | |
Value | Meaning | |
TRUE | Keep column breaks. | |
FALSE | Do not keep column breaks. | |
bConsolidatePages | Specifies whether to consolidate pages. Possible values are: | |
Value | Meaning | |
TRUE | Consolidate pages. | |
FALSE | Do not consolidate pages. | |
pszDocAuthor |
Character string that specifies the author of the document. The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL). |
|
pszDocCategory |
Specifies the category of the document. The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL). |
|
pszDocComments |
Specifies the comments for the document. The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL). |
|
pszDocCompany |
Specifies the company name of the document. The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL). |
|
pszDocKeywords |
Specifies the keywords for the document. The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL). |
|
pszDocManager |
Specifies the name of the manager of the document. The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL). |
|
pszDocSubject |
Specifies the subject of the document. The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL). |
|
pszDocTitle |
Specifies the title of the document. The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL). |
|
bDropCaps | Specifies whether to use drop caps. Possible values are: | |
Value | Meaning | |
TRUE | Use drop caps. | |
FALSE | Do not use drop caps. | |
bFieldCodes | Specifies whether to retain field codes. Possible values are: | |
Value | Meaning | |
TRUE | Retain field codes. | |
FALSE | Do not retain field codes. | |
HFSetng | Specifies the header and footer settings for the document. For a list of possible values, refer to DOC2_HEADERFOOTERSETTING. | |
bLineBreaks | Specifies whether to insert line breaks. Possible values are: | |
Value | Meaning | |
TRUE | Insert line breaks. | |
FALSE | Do not insert line breaks. | |
OutputMode | Specifies output mode. For list of possible values, refer to DOC2_FORMATLEVEL. | |
PgBreakValue | Enumerated values that specify how to handle page breaks . For list of possible values, refer to DOC2_PAGEBREAKSETTING. | |
bPageColor | Specifies whether to retain the page background color or use the default. | |
Value | Meaning | |
TRUE | Retain the page background color. | |
FALSE | Use the default background color. | |
DpiSetng | Specifies the DPI setting. For a list of possible values, refer to DOC2_DPISETTING. | |
bRuleLines | Specifies whether to insert rule lines. Possible values are: | |
Value | Meaning | |
TRUE | Insert rule lines. | |
FALSE | Do not insert rule lines. | |
bStyles | Specifies whether to retain styles. Possible values are: | |
Value | Meaning | |
TRUE | Retain styles. | |
FALSE | Do not retain styles. | |
TableSetng | Specifies the table settings. For a list of possible values, refer to DOC2_TABLESETTING. | |
bTabs | Specifies whether to retain the original tab positions or to use the defaults. Possible values are: | |
Value | Meaning | |
TRUE | Retain the original tab positions. | |
FALSE | Use the default tab positions. |
pRTFDOCWORDMLSETTINGS is a pointer to a RTFDOCWORDMLSETTINGS structure. If the function parameter type is pRTFDOCWORDMLSETTINGS, declare a RTFDOCWORDMLSETTINGS variable, update the structure's fields, and pass the variable's address in the parameter. Declaring a pRTFDOCWORDMLSETTINGS variable is necessary only if the program requires a pointer.
This structure is used with the following functions: