ITabRange.Footnotes

Syntax

Description

The Footnotes property returns the collection of footnotes in the current range.

Comments

The property enables the user to get a specific collection footnotes relative only to the current range. This collection is also a part of the table footnote collection which is returned by the ITabSheet.Footnotes property.

Example

Executing the example requires a form with the Button1 button, the UiTabSheet component named UiTabSheet1 and any components for which UiTabSheet1 is set as a data source. Footnotes are created for table cells.

Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);
Var
    TabSheet: ITabSheet;
    TabRange: ITabRange;
    Footnotes: ITabFootnoteCollection;
    Footnote: ITabFootnote;
Begin
    TabSheet := UiTabSheet1.TabSheet;
    TabRange := TabSheet.View.Selection.Range;
    Footnotes := TabRange.Footnotes;
    For Each Footnote In Footnotes Do
        If Footnote.CustomMark = "" Then
            Debug.WriteLine("Footnote: " + Footnote.NumberText + ". Text: " + Footnote.Text);
        Else
            Debug.WriteLine("Footnote: " + Footnote.CustomMark + ". Text: " + Footnote.Text);
        End If;
    End For;
End Sub Button1OnClick;

Clicking the button displays a list of footnotes which are in the selected cell range to the development environment console.