Xceed Words for .NET v3.0 Documentation
InsertTableOfContents(Paragraph,String,IDictionary<TableOfContentsSwitches,String>,String,Nullable<Int32>) Method


Xceed.Document.NET Assembly > Xceed.Document.NET Namespace > Document Class > InsertTableOfContents Method : InsertTableOfContents(Paragraph,String,IDictionary<TableOfContentsSwitches,String>,String,Nullable<Int32>) Method
The referenced paragraph to indicate the position of the table of contents.
The title of the table of contents.
A key-value dictionary where the key is a TableOfContentSwitches and the value is the parameter of the switch.
The style to use for the title of the table of contents.
The position of the text aligned from the right.
Inserts a table of contents to the document prior to the referenced paragraph, based on the provided switches.
Syntax
'Declaration
 
Public Overloads Function InsertTableOfContents( _
   ByVal reference As Paragraph, _
   ByVal title As String, _
   ByVal switches As IDictionary(Of TableOfContentsSwitches,String), _
   Optional ByVal headerStyle As String, _
   Optional ByVal rightTabPos As Nullable(Of Integer) _
) As TableOfContents
'Usage
 
Dim instance As Document
Dim reference As Paragraph
Dim title As String
Dim switches As IDictionary(Of TableOfContentsSwitches,String)
Dim headerStyle As String
Dim rightTabPos As Nullable(Of Integer)
Dim value As TableOfContents
 
value = instance.InsertTableOfContents(reference, title, switches, headerStyle, rightTabPos)

Parameters

reference
The referenced paragraph to indicate the position of the table of contents.
title
The title of the table of contents.
switches
A key-value dictionary where the key is a TableOfContentSwitches and the value is the parameter of the switch.
headerStyle
The style to use for the title of the table of contents.
rightTabPos
The position of the text aligned from the right.

Return Value

The newly inserted table of contents.
Requirements

Target Platforms: Windows 11, Windows 10, Windows 7, Windows, 11, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

Document Class
Document Members
Overload List