GrapeCity.Documents.Word.Fields.TcFieldOptions

Class TcFieldOptions

Namespace

GrapeCity.Documents.Word.Fields

Assembly

GcDocs.Word.dll

Represents TC field options.

A TC field defines the text and page number for a table of contents (including a table of figures) entry, which is used by a TOC field.

public class TcFieldOptions : BaseFieldOptions, IFieldOptions

Inheritance

object

BaseFieldOptions

TcFieldOptions

Implements

IFieldOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

TcFieldOptions(ComplexField)

Initializes a new instance of the TcFieldOptions class.

public TcFieldOptions(ComplexField field)

Parameters

field ComplexField

The ComplexField from which to load the options.

TcFieldOptions(DocumentBase)

Initializes a new instance of the TcFieldOptions class.

public TcFieldOptions(DocumentBase doc)

Parameters

doc DocumentBase

The document whose resources to use in this instance.

TcFieldOptions(SimpleField)

Initializes a new instance of the TcFieldOptions class.

public TcFieldOptions(SimpleField field)

Parameters

field SimpleField

The SimpleField from which to load the options.

Properties

Content

Gets the TOC item content.

public InlineRichText Content { get; }

Property Value

InlineRichText

DisplayLevel

Gets or sets the level to display entry in a TOC field result.

Default value is Level1.

public OutlineLevel DisplayLevel { get; set; }

Property Value

OutlineLevel

Exceptions

ArgumentOutOfRangeException

Thrown when trying to set BodyText.

OmitPageNumber

Gets or sets whether to omit the page number for the entry in a TOC field result.

Default value is false.

public bool OmitPageNumber { get; set; }

Property Value

bool

Type

Gets or sets the type of entry collected in a particular contents list.

Use a unique list type identifier for each type of list.

If no list type is specified, the entry is listed in a table of contents.

Default value is null.

public char? Type { get; set; }

Property Value

char?

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