DS.Documents.Word Assembly

GrapeCity.Documents.Word.Fields.TocFieldOptions

TocFieldOptions Class

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.

Inheritance

object

BaseFieldOptions

TocFieldOptions

Implements

IFieldOptions

Namespace: GrapeCity.Documents.Word.Fields

Assembly: DS.Documents.Word.dll

Syntax

public class TocFieldOptions : BaseFieldOptions, IFieldOptions

Public Class TocFieldOptions
    Inherits BaseFieldOptions
    Implements IFieldOptions

Constructors

Name	Description
TocFieldOptions(ComplexField)	Initializes a new instance of the TocFieldOptions class.
TocFieldOptions(DocumentBase)	Initializes a new instance of the TocFieldOptions class.
TocFieldOptions(SimpleField)	Initializes a new instance of the TocFieldOptions class.

Properties

Name	Description
Bookmark	Gets or sets the name of the bookmark that limits the entries to those within the portion of the document defined by the bookmark.
EntryFormatting	Gets options to format TOC entries in the TOC field result.
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.
PageNumbers	Gets options to show page numbers in the TOC field result.
SeqFields	Gets options to collect SEQ fields paragraphs by the TOC field.
Styles	Gets the collection of styles of paragraphs which should be collected by the TOC field.
TcFields	Gets options to collect TC fields by the TOC field.

Methods

Name	Description
Load(ComplexField)	Loads options from the specified ComplexField.
Load(SimpleField)	Loads options from the specified SimpleField.
Save(ComplexField)	Saves the current options to the specified ComplexField.
Save(SimpleField)	Saves the current options to the specified SimpleField.
ToString()