Description

The event argument for footnote related events.

Syntax

{
   name: <string>,
   number: <Number>,
   referenceMarkLength: <Number>,
   referenceMarkStart: <Number>,
   highlightColor: <string>,
   highlightMode: <string>,
   id: <Number>
}

Examples

The following example demonstrates FootnoteEventArgs in a practical document-editing workflow. The event argument for footnote related events.

function handleFootnote(args) {
    console.log("name:", args.name);
    console.log("number:", args.number);
    console.log("reference mark length:", args.referenceMarkLength);
    console.log("reference mark start:", args.referenceMarkStart);
}

Members

Properties

Property	Description
highlightColor	The footnote's highlight color.
highlightMode	The footnote's highlight mode (see TXTextControl.HighlightMode).
id	The footnote's identifier.
name	The footnote's name.
number	The footnote's 1-based number in the text flow.
referenceMarkLength	The footnote's reference mark length in characters.
referenceMarkStart	The footnote's 1-based reference mark start position.