Footnote Object

Description

A Footnote object represents a footnote in a TextControl document. A footnote can be inserted trough the FootnoteCollection.add method. It consists of a reference mark in the document and the footnote itself appearing at the bottom of the page. The footnote has a footnote mark with the same number as the reference mark. All Footnote objects are contained in the FootnoteCollection, which can be obtained with the TXTextControl.footnotes property.

Syntax

Footnote

Examples

The following example demonstrates Footnote in a practical document-editing workflow. A Footnote object represents a footnote in a TextControl document. A footnote can be inserted trough the FootnoteCollection.add method. It consists of a reference mark in the document and the footnote itself appearing at the bottom of the page. The footnote has a footnote mark with the same number as the reference mark. All Footnote objects are contained in the FootnoteCollection, which can be obtained with the TXTextControl.footnotes property.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

TXTextControl.footnotes.elementAt(0, function(footnote) {
    if (!footnote) {
        console.warn("No footnote is available.");
        return;
    }

    footnote.getID(
        function(result) {
            console.log("get id result:", result);
        },
        onTxError
    );
}, onTxError);

Members

Methods