GrapeCity.Documents.Word.Fields.TocFieldOptions

Class TocFieldOptions

Namespace

GrapeCity.Documents.Word.Fields

Assembly

GcDocs.Word.dll

Represents TOC field options.

A TOC field builds a table of contents (which can also be a table of figures) using the entries specified by TC fields, their heading levels, and specified styles, and inserts that table at its place in the document. Each table entry is a separate paragraph.

public class TocFieldOptions : BaseFieldOptions, IFieldOptions

Inheritance

object

BaseFieldOptions

TocFieldOptions

Implements

IFieldOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

TocFieldOptions(ComplexField)

Initializes a new instance of the TocFieldOptions class.

public TocFieldOptions(ComplexField field)

Parameters

field ComplexField

The ComplexField from which to load the options.

TocFieldOptions(DocumentBase)

Initializes a new instance of the TocFieldOptions class.

public TocFieldOptions(DocumentBase doc)

Parameters

doc DocumentBase

The document whose resources to use in this instance.

TocFieldOptions(SimpleField)

Initializes a new instance of the TocFieldOptions class.

public TocFieldOptions(SimpleField field)

Parameters

field SimpleField

The SimpleField from which to load the options.

Properties

Bookmark

Gets or sets the bookmark name that allows to include entries only from the portion of the document marked by this bookmark.

Default value is null.

public string Bookmark { get; set; }

Property Value

string

EntryFormatting

Gets options to format TOC entries in the TOC field result.

public TocEntryFormatting EntryFormatting { get; }

Property Value

TocEntryFormatting

FlatList

Gets or sets whether the all TOC entries should be on the same level.

Default value is false.

If the Collect is true this property is also true.

public bool FlatList { get; set; }

Property Value

bool

PageNumbers

Gets options to show page numbers in the TOC field result.

public TocPageNumberOptions PageNumbers { get; }

Property Value

TocPageNumberOptions

SeqFields

Gets options to collect SEQ fields paragraphs by the TOC field.

public TocSeqOptions SeqFields { get; }

Property Value

TocSeqOptions

Styles

Gets the collection of styles of paragraphs which should be collected by the TOC field.

public TocStyleLevelCollection Styles { get; }

Property Value

TocStyleLevelCollection

TcFields

Gets options to collect TC fields by the TOC field.

public TocTcOptions TcFields { get; }

Property Value

TocTcOptions

Methods

Load(ComplexField)

Loads options from a ComplexField.

public void Load(ComplexField field)

Parameters

field ComplexField

The ComplexField from which to load the options.

Load(SimpleField)

Loads options from a SimpleField.

public void Load(SimpleField field)

Parameters

field SimpleField

The SimpleField from which to load the options.

Save(ComplexField)

Saves options to a ComplexField.

public void Save(ComplexField field)

Parameters

field ComplexField

The ComplexField where to save the options.

Save(SimpleField)

Saves options to a SimpleField.

public void Save(SimpleField field)

Parameters

field SimpleField

The SimpleField where to save the options.

ToString()

public override string ToString()

Returns

string