TableOfContentsEventArgs Class
- Namespace
TXTextControl
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. Core. SDK
- Assembly
TXTextControl.Core. dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. Core. SDK TXTextControl.from the setup.dll
- Also in
TXTextControl.asTextControl. ASP. SDK TXTextControl.dll
- Inherits
- Event
Args - Table
Of Contents Event Args
- Event
Description
The TableOfContentsEventArgs class provides data for the TableOfContentsCreated, TableOfContentsDeleted, TableOfContentsEntered and TableOfContentsLeft events. When a table of contents is deleted, the TableOfContents object provided with the event data has the following valid properties: HighlightColor, HighlightMode, ID, Name, MinimumStructureLevel, MaximumStructureLevel, HasLinks, HasPageNumbers and HasRightAlignedPageNumbers. All other properties are undefined.
Syntax
public class TableOfContentsEventArgs : EventArgsPublic Class TableOfContentsEventArgs
Inherits EventArgsExamples
The following example uses TableOfContentsEventArgs.TableOfContents while handling TableOfContentsCreated.
textControl.TableOfContentsCreated += (_, e) =>
{
e.TableOfContents?.ScrollTo();
};AddHandler textControl.TableOfContentsCreated,
Sub(sender, e)
If e.TableOfContents IsNot Nothing Then e.TableOfContents.ScrollTo()
End SubMembers
Properties
| Property | Description |
|---|---|
| TableOfContents | Gets an object that represents the table of contents which causes the event. It is of the type TableOfContents. |