TableOfContentsEventArgs Class

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 : EventArgs

Public Class TableOfContentsEventArgs
    Inherits EventArgs

Examples

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 Sub

Members

Properties