[]
        
(Showing Draft Content)

GrapeCity.Documents.Word.Fields.TocPageNumberOptions

Class TocPageNumberOptions

Namespace
GrapeCity.Documents.Word.Fields
Assembly
GcDocs.Word.dll

Represents options used when showing page numbers in a TOC field result.

public class TocPageNumberOptions
Inheritance
TocPageNumberOptions
Inherited Members

Properties

OmitLevels

Gets the range of TOC entry levels for which the page numbers should be omitted.

The default value is IsEmpty.

public OutlineLevelRange OmitLevels { get; }

Property Value

OutlineLevelRange

PrefixSeparator

Gets or sets the character that separates the prefix (see PrefixSequenceId property) and page number in TOC entries.

The default value is '-'.

public char PrefixSeparator { get; set; }

Property Value

char

PrefixSequenceId

Gets or sets the Id of SEQ fields whose result should prefix TOC entries page numbers.

The default value is Empty.

public string PrefixSequenceId { get; set; }

Property Value

string

Separator

Gets or sets the character that separates a TOC entry and its page number.

The default value is GrapeCity.Documents.Word.SpecialChars.Tab.

public char Separator { get; set; }

Property Value

char

ShowPageNumbers

Gets or sets a value indicating whether to show page numbers for TOC entries.

The default value is true.

public bool ShowPageNumbers { get; set; }

Property Value

bool

Methods

ToString()

public override string ToString()

Returns

string