DS Server

FootnoteCollection Object

Object|Introduced in 32.0

Description

Contains all footnotes in a Text Control document.

Syntax

FootnoteCollection

Examples

The following example demonstrates FootnoteCollection in a practical document-editing workflow. It contains all footnotes in a Text Control document.

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

TXTextControl.footnotes.getDefaultFootnoteHighlightColor(
    function(result) {
        console.log("get default footnote highlight color result:", result);
    },
    onTxError
);

Members

Methods

Method	Description
add	Adds a new footnote with the given text to the document at the current input position. A footnote consists of a reference mark in the document and the footnote itself appearing at the bottom of the page.
elementAt	Returns the element at a specified index in the collection. (Inherited from Collection.)
forEach	Executes a callback function for each element. (Inherited from Collection.)
getCount	Gets the number of elements contained in the collection. (Inherited from Collection.)
getDefaultFootnoteHighlightColor	Gets the default highlight color for the reference mark and the footnote mark.
getHighlightMode	Gets a value indicating whether all the footnote numbers, reference marks as well as footnote marks, in the document are highlighted.
getNumberFormat	Gets the footnotes' number format.
getStartNumber	Gets the number for the first footnote.
remove	Removes a footnote from a Text Control document.
setHighlightMode	Sets a value indicating whether all the footnote numbers, reference marks as well as footnote marks, in the document are highlighted.
setNumberFormat	Sets the footnotes' number format.
setStartNumber	Sets the number for the first footnote.