KeyView 23.4

# KVHTMLTOCOptions

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

- it meets all the criteria defined by the members of `KVHTMLHeadingInfo` (see KVHTMLHeadingInfo), and

- the `headingCreateType` member of `KVHTMLTOCOptions` is set to allow automatic heading generation.

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

When PDF files are converted to HTML by using the default reader, `pdfsr`, the table of contents is generated from "bookmarks" within the PDF file. This structure is not used.

    Typedef struct tag_KVHTMLTOCOptions
    {
        BOOL                      bAllowHeadingsInTables;
        KVHeadingCreateOptions    headingCreateType;
        KVHTMLHeadingInfo         *pH1;
        KVHTMLHeadingInfo         *pH2;
        KVHTMLHeadingInfo         *pH3;
        KVHTMLHeadingInfo         *pH4;
        KVHTMLHeadingInfo         *pH5;
        KVHTMLHeadingInfo         *pH6;
    }
    KVHTMLTOCOptions;

## Member Descriptions

`bAllowHeadingsInTables` | This option determines if 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 HTML Export subdivides the source document into table of contents entries. This should be set to one of the two options that are enumerated in `KVHeadingCreateOptions` in `kvhtml.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 `KVHTMLHeadingInfo` structure. See KVHTMLHeadingInfo. 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`.
`KVHTMLHeadingInfo` | A pointer to the `KVHTMLHeadingInfo` structure. SeeKVHTMLHeadingInfo. When the table of contents entries are not based on the source documents heading styles, 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 `KVHTMLHeadingInfo`.

## Discussion

A pointer to this structure is passed as an argument to `fpConvertStream()` and `KVHTMLConvertFile()`. 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.

Copyright 1997-2023 Open Text
Version 23.4 | Last updated September 2023

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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL KeyView 23.4

Topic Title: KVHTMLTOCOptions