FootnoteCollection Class — TX Text Control .NET for Windows Forms

Description

An instance of the FootnoteCollection class contains all footnotes in a Text Control document represented through objects of the type Footnote. An instance of this class can be obtained with the TextControl.Footnotes, WPF.TextControl.Footnotes and ServerTextControl.Footnotes property. The FootnoteCollection class implements the IEnumerable and the ICollection interfaces.

Syntax

public sealed class FootnoteCollection : ICollection, IEnumerable

Public NotInheritable Class FootnoteCollection
    Implements ICollection, IEnumerable

Examples

The following example works with footnotes in the current document.

textControl.Text = "Customer: Contoso Ltd.";
textControl.Select(10, 12);
FootnoteCollection footnoteCollection = textControl.Footnotes;
footnoteCollection.Add(new Footnote("Source: FY 2026 annual report") { ID = 100 }, false);

textControl.Text = "Customer: Contoso Ltd."
textControl.Select(10, 12)
Dim footnoteCollection As FootnoteCollection = textControl.Footnotes
footnoteCollection.Add(New Footnote("Source: FY 2026 annual report") With { .ID = 100 }, False)

Members

Properties

Property	Description
Count	Gets the number of elements contained in the collection.
HighlightMode	Gets or sets a value indicating whether all the footnote numbers, reference marks as well as footnote marks, in the document are highlighted.
Item	Gets the footnote with the specified number from the collection. The number must be between 1 and Count. In C# this property is the indexer for the FootnoteCollection class.
NumberFormat	Gets or sets the footnotes' number format. The property's value is a member of the NumberFormat enumeration.
StartNumber	Gets or sets the number for the first footnote.

Methods

Method	Description
Add	Adds a new footnote to the document at the current text input position. A footnote consists of a reference mark in the document and the footnote itself appearing at the bottom of the page.
CopyTo	Copies the elements of the collection to an array, starting at a particular index.
GetEnumerator	Returns an enumerator that can be used to iterate through the collection.
GetItem	Gets a particular footnote from the collection.
Remove	Removes a footnote from a Text Control document.