GrapeCity.Documents.Word.Fields.TocStyleLevel

Class TocStyleLevel

Namespace

GrapeCity.Documents.Word.Fields

Assembly

GcDocs.Word.dll

Represents a pair of a style name and its display level for TOC field options.

public class TocStyleLevel

Inheritance

object

TocStyleLevel

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Collect

Gets or sets a value indicating whether to collect paragraphs formatted with the style.

The default value is true.

Note that for "Heading 1" built-in style, if both Collect and Collect are false, and all other styles are not marked for collection, then this property returns true regardless of the assigned value.

public bool Collect { get; set; }

Property Value

bool

DisplayLevel

Gets or sets the outline level on which to display collected paragraphs in the TOC field result.

The default value is Level1 for custom styles, and the corresponding outline level for built-in heading styles.

public OutlineLevel DisplayLevel { get; set; }

Property Value

OutlineLevel

Exceptions

ArgumentOutOfRangeException

Thrown when trying to assign BodyText.

IsBuiltIn

Gets a value indicating whether the style is a built-in heading style.

public bool IsBuiltIn { get; }

Property Value

bool

Level

Gets the built-in style outline level.

For custom styles the property value returns null.

public OutlineLevel? Level { get; }

Property Value

OutlineLevel?

Name

Gets style name of paragraphs that should be collected by the TOC field.

public string Name { get; }

Property Value

string

Methods

ToString()

public override string ToString()

Returns

string