TX Text Control .NET Server

FootnoteEventArgs Class

Class|Introduced in 32.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.Core.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.Core.dll
Install
dotnet add package TXTextControl.TextControl.Core.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.dll from the setup.
Also in
TXTextControl.TextControl.ASP.SDK as TXTextControl.dll
Inherits
  1. EventArgs
  2. FootnoteEventArgs

Description

The FootnoteEventArgs class provides data for the FootnoteCreated, FootnoteDeleted, FootnoteReferenceMarkEntered and FootnoteReferenceMarkLeft events. When a footnote is deleted, the Footnote object provided with the event data has the following valid properties: HighlightColor, HighlightMode, ID and Name. All other properties are undefined.

Syntax

public class FootnoteEventArgs : EventArgs

Examples

The following example uses FootnoteEventArgs.Footnote while handling FootnoteCreated.

textControl.FootnoteCreated += (_, e) =>
{
    e.Footnote?.ScrollTo();
};

Members

Properties

PropertyDescription
FootnoteGets an object that represents the footnote which causes the event. It is of the type Footnote.