KVXMLTOCOptions

This structure defines whether a heading is included in the table of contents. Source text is converted to a heading in the XML output if

The structure is initialized by calling the fpConvertStream() or KVXMLConvertFile() function. See fpConvertStream() or KVXMLConvertFile().

See KVXMLOptions for more information on the criteria used to determine whether a heading is included in the table of contents.

Typedef struct tag_KVXMLTOCOptions
{
    BOOL                    bAllowHeadingsInTables;
    KVHeadingCreateOptions  headingCreateType;
    KVXMLHeadingInfo        *pH1;
    KVXMLHeadingInfo        *pH2;
    KVXMLHeadingInfo        *pH3;
    KVXMLHeadingInfo        *pH4;
    KVXMLHeadingInfo        *pH5;
    KVXMLHeadingInfo        *pH6;
}
KVXMLTOCOptions;

Member Descriptions

bAllowHeadingsInTables

This option determines whether the text in tables is considered for automatic heading generation. If you set bAllowHeadingsInTables to TRUE, the text in tables is included in the determination of headings and table of contents entries.

This option applies to word processing documents and spreadsheets only.

The default is FALSE.

headingCreateType

This option determines how XML Export subdivides the source document into table of contents entries. You can set this option to one of the two options enumerated in KVHeadingCreateOptions in kvxml.h. See KVHeadingCreateOptions.

The determination of table of contents entries is based on whether the source document contains heading styles or whether text attributes conform to the criteria defined in the KVXMLHeadingInfo structure. See KVXMLHeadingInfo.

Heading styles are predefined style tags, such as "Heading 1" and "Heading 2" tags in a Microsoft Word document. Text attributes are bold, underlined, italic, and so on.

This option applies to word processing documents only.

The default is KVCS_DocHeadingsOnly.

KVXMLHeadingInfo

A pointer to the KVXMLHeadingInfo structure. See KVXMLHeadingInfo.

When the table of contents entries are not based on the heading styles of the source document, the table of contents entries are determined by whether text attributes (such as bold, underlined, and italic text) in the source document meet all the criteria defined in KVXMLHeadingInfo.

Discussion

A pointer to this structure is passed as an argument to fpConvertStream() and KVXMLConvertFile(). If the pointer to the structure is not NULL, the values of the members specified in the structure are used. If the pointer to the structure is NULL, the default values are used.