Class TableOfContentsOptions

Options that control how a TableOfContents is generated. Mirrors the Word "Table of Contents" dialog options and the TOC field switches.

Inheritance

object

TableOfContentsOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DRIT.Document

Assembly: DRIT.Document.dll

Syntax

public class TableOfContentsOptions

Constructors

TableOfContentsOptions()

Initializes a new instance of the TableOfContentsOptions class.

Declaration

public TableOfContentsOptions()

Properties

HeadingLevelEnd

The ending heading level to include (1-9). Default is 3. Maps to the second number in the TOC \o switch.

Declaration

public int HeadingLevelEnd { get; set; }

Property Value

Type	Description
int

HeadingLevelStart

The starting heading level to include (1-9). Default is 1. Maps to the first number in the TOC \o switch.

Declaration

public int HeadingLevelStart { get; set; }

Property Value

Type	Description
int

HideTabAndPageNumbersInWeb

When true, hides tab leaders and page numbers in web view. Maps to the TOC \z switch. Default is false.

Declaration

public bool HideTabAndPageNumbersInWeb { get; set; }

Property Value

Type	Description
bool

UseHyperlinks

When true, TOC entries are hyperlinked to their headings. Maps to the TOC \h switch. Default is true.

Declaration

public bool UseHyperlinks { get; set; }

Property Value

Type	Description
bool

UseOutlineLevels

When true, uses outline levels (not just heading styles) to determine which paragraphs appear in the TOC. Maps to the TOC \u switch. Default is true.

Declaration

public bool UseOutlineLevels { get; set; }

Property Value

Type	Description
bool

Methods

ToSwitches()

Builds the TOC field switches string from these options (e.g. \o "1-3" \h \z \u).

Declaration

public string ToSwitches()

Returns

Type	Description
string