KeyView 24.4
KeyView XML Export SDK C Programming Guide

# KVXMLHeadingInfo

This structure defines how XML Export creates heading information based on the source document's content and attributes. Source text is converted to a heading and included in the table of contents if

- it meets all the criteria defined by this structure, and

- you set the `headingCreateType` member of `KVXMLTOCOptions` to allow automatic heading generation.

XML Export evaluates the text against each member in the order in which the members appear below.

See KVXMLTOCOptions for more information on automatic generation of headings.

    typedef struct tag_KVXMLHeadingInfo
    {
        int    minParaLen;
        int    maxParaLen;
        int    fontSizeMin;
        int    fontSizeMax;
        BOOL   bMustBeBold;
        BOOL   bMustBeItalic;
        BOOL   bMustBeUnderlined;
        BOOL   bNonZeroIndent;
        BOOL   bNoTabs;
        BOOL   bNoMultiSpaces;
        int    nSpaceBefore;
        int    nSpaceAfter;
    }
    KVXMLHeadingInfo;

## Member Descriptions

`minParaLen` | The minimum number of characters that a paragraph in the source document can contain for the text to meet the criteria for heading conversion. This option applies to word processing documents only. The default is 3 for heading levels 1 to 3.
`maxParaLen` | The maximum number of characters that a paragraph in the source document can contain for the text to meet the criteria for heading conversion. This option applies to word processing documents only. The default is 80 for heading levels 1 to 3.
`fontSizeMin` | The minimum font size of text in the source document for the text to meet the criteria for heading conversion. The default is 14 for heading level 1, and 12 for heading levels 2 and 3.
`fontSizeMax` | The maximum font size of text in the source document for the text to meet the criteria for heading conversion. The default is 20 for heading level 1, and 14 for heading levels 2 and 3.
`bMustBeBold` | If you set `bMustBeBold` to `TRUE`, the text in the source document must be bold to meet the criteria for heading conversion. The default is `TRUE` for heading levels 1 and 2, and `FALSE` for heading level 3.
`bMustBeItalic` | If you set `bMustBeItalic` to `TRUE`, the text in the source document must be italic to meet the criteria for heading conversion. The default is `FALSE`.
`bMustBeUnderlined` | If you set `bMustBeUnderlined` to `TRUE`, the text in the source document must be underlined to meet the criteria for heading conversion. The default is `FALSE`.
`bNonZeroIndent` | If you set `bNonZeroIndent` to `TRUE`, the text in the source document must be indented to meet the criteria for heading conversion.If you set `bNonZeroIndent` to `FALSE`, the text must be aligned left. The default is `FALSE`.
`bNoTabs` | If you set `bNoTabs` to `TRUE`, the text in the source document must not contain tabs to meet the criteria for heading conversion. The default is `FALSE`.
`bNoMultiSpaces` | If you set `bNoMultiSpaces` to `TRUE`, the text in the source document must not contain two or more contiguous white spaces to meet the criteria for heading conversion. The default is `FALSE`.
`nSpaceBefore` | The amount of space in TWIPS (20th of a point) that must come before a paragraph in the source document for the text to meet the criteria for heading conversion. If `–1` is used, the amount of space before the paragraph is not considered in the heading generation. The default is `0`.
`nSpaceAfter` | The amount of space in TWIPS (20th of a point) that must follow a paragraph in the source document for the text to meet the criteria for heading conversion. If `–1` is used, the amount of space after the paragraph is not considered in the heading generation. The default is `0`.

Copyright 1997-2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.4

Topic Title: KVXMLHeadingInfo