Footnotes

Classes

Class Description
TXTextControl.Footnote A Footnote object represents a footnote in a TextControl document.
TXTextControl.FootnoteCollection An instance of the FootnoteCollection class contains all footnotes in a Text Control document represented through objects of the type Footnote.
TXTextControl.FootnoteEventArgs The FootnoteEventArgs class provides data for the FootnoteCreated, FootnoteDeleted, FootnoteReferenceMarkEntered and FootnoteReferenceMarkLeft events.
TXTextControl.FootnoteSection The FootnoteSection class represents a footnote section at the bottom of a page.
TXTextControl.FootnoteText The FootnoteText class represents the text of all footnotes contained in a document.

Constructors

Constructor Description
TXTextControl.Footnote Initializes a new instance of the Footnote class.

Events

Event Description
TXTextControl.ServerTextControl.FootnoteCreated Occurs when a footnote has been created.
TXTextControl.ServerTextControl.FootnoteDeleted Occurs when a footnote has been deleted.

Methods

Method Description
TXTextControl.Footnote.Edit Sets the current text input position in the footnote section at the end of the current footnote text, so that the text can be edited or formatted.
TXTextControl.Footnote.Save Saves the footnote's text with the specified format including the footnote mark in front of the text.
TXTextControl.Footnote.ScrollTo Sets the current input position to the first position of the footnote mark and scrolls it into the visible part of the document.
TXTextControl.FootnoteCollection.Add Adds a new footnote to the document at the current text input position.
TXTextControl.FootnoteCollection.CopyTo Copies the elements of the collection to an array, starting at a particular index.
TXTextControl.FootnoteCollection.GetEnumerator Returns an enumerator that can be used to iterate through the collection.
TXTextControl.FootnoteCollection.GetItem Gets a particular footnote from the collection.
TXTextControl.FootnoteCollection.Remove Removes a footnote from a Text Control document.
TXTextControl.ServerTextControl.OnFootnoteCreated Raises the FootnoteCreated event.
TXTextControl.ServerTextControl.OnFootnoteDeleted Raises the FootnoteDeleted event.

Properties

Property Description
TXTextControl.Footnote.DefaultHighlightColor Gets the default highlight color for the reference mark and the footnote mark.
TXTextControl.Footnote.HighlightColor Gets or sets the highlight color for the reference mark and the footnote mark.
TXTextControl.Footnote.HighlightMode Gets or sets a value indicating whether the reference mark and the footnote mark is highlighted.
TXTextControl.Footnote.ID Gets or sets a user-defined identifier.
TXTextControl.Footnote.Name Gets or sets a name for the footnote.
TXTextControl.Footnote.Number Gets the footnote's number in the text.
TXTextControl.Footnote.ReferenceMarkLength Gets the number of characters the reference mark consists of.
TXTextControl.Footnote.ReferenceMarkStart Gets the index (one-based) of the first character of the footnote's reference mark.
TXTextControl.Footnote.Text Gets the footnote's text including the footnote mark in front of the text.
TXTextControl.FootnoteCollection.Count Gets the number of elements contained in the collection.
TXTextControl.FootnoteCollection.HighlightMode Gets or sets a value indicating whether all the footnote numbers, reference marks as well as footnote marks, in the document are highlighted.
TXTextControl.FootnoteCollection.Item Gets the footnote with the specified number from the collection.
TXTextControl.FootnoteCollection.NumberFormat Gets or sets the footnotes' number format.
TXTextControl.FootnoteCollection.StartNumber Gets or sets the number for the first footnote.
TXTextControl.FootnoteEventArgs.Footnote Gets an object that represents the footnote which causes the event.
TXTextControl.FootnoteSection.Charts Gets a collection of all charts contained in the footnote section of a page.
TXTextControl.FootnoteSection.TextFrames Gets a collection of all text frames contained in the footnote section of a page.
TXTextControl.FootnoteText.Charts Gets a collection of all charts contained in the footnotes' text.
TXTextControl.FootnoteText.TextFrames Gets a collection of all text frames contained in the footnotes' text.
TXTextControl.ServerTextControl.Footnotes Gets a collection of all footnotes contained in the main text of the document.