Document Editor · Advanced Features

Footnotes

Footnotes add supporting information or citations at the bottom of document pages without interrupting the main text.

Live footnote API

Insert and inspect document footnotes

Add supporting information without interrupting the main text, then follow the live connection between its reference mark and note at the bottom of the page.

Create a footnote

The reference mark is inserted at the current caret position.

Footnote text

Semantic name Application ID

Place the caret on a reference markThe inspector follows the footnote connected to the current mark.

Footnotes in this document

Numbers are calculated from text flow; names and IDs remain stable metadata.

0 notes

Start number Number format

Reading the footnote collection...

What this demonstrates

Reference marks and page-bottom notes form one object

A footnote lets the main text stay readable while citations, legal qualifications, or supporting detail remain attached to an exact document position. TX Text Control keeps the reference mark and its note synchronized as text is edited and repaginated.

Footnote collection

TXTextControl.footnotes

Insertion

FootnoteCollection.add

Reference events

footnoteReferenceMarkEntered / footnoteReferenceMarkLeft

Navigation

Footnote.edit / scrollTo

How it works

FootnoteCollection.add inserts a reference mark at the current input position and creates the corresponding note at the bottom of the page. Its callback returns both an added flag and the new Footnote object.

A Footnote has two identities. getNumber returns its position-dependent number in the document's text flow, while getName and getID expose stable application metadata. Moving paragraphs can therefore renumber notes without breaking application references.

getReferenceMarkStart and getReferenceMarkLength describe the one-based range of the marker in the main text. The footnoteReferenceMarkEntered and footnoteReferenceMarkLeft events keep the inspector synchronized without repeatedly scanning the selection.

Footnote.edit activates the footnote text part and moves the caret to the end of the note. Collection-wide setStartNumber and setNumberFormat update every reference and note mark consistently.

Insert a named footnote

TXTextControl.footnotes.add(
    "Supporting information shown at the bottom of the page.",
    "supporting-context",
    100,
    result => {
        if (result.added) {
            result.footnote.edit();
        }
    },
    showFootnoteError);