Class TableOfContentsField

Represents a field that generates a table of contents in a document.

Inheritance
System.Object
Field
CodeBasedField
TableOfContentsField
Inherited Members
Namespace: Telerik.Windows.Documents.Model
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public class TableOfContentsField : CodeBasedField, ISupportInitialize

Constructors

TableOfContentsField()

Declaration
public TableOfContentsField()

Fields

AlignmentStringProperty

Gets or sets the string representation of the alignment for the Table of Contents field.

Declaration
public static readonly FieldPropertyDefinition AlignmentStringProperty
Field Value
FieldPropertyDefinition

A string value that specifies the alignment, which can include options such as "Left", "Center", and "Right".

CaptionNameProperty

Gets the name of the caption for the table of contents field.

Declaration
public static readonly FieldPropertyDefinition CaptionNameProperty
Field Value
FieldPropertyDefinition

DefaultAlignmentString

Declaration
public static readonly string DefaultAlignmentString
Field Value
System.String

ErrorString

Declaration
public static readonly string ErrorString
Field Value
System.String

FieldType

Declaration
public static readonly string FieldType
Field Value
System.String

InvalidHeadingLevelRangeErrorString

Declaration
public static readonly string InvalidHeadingLevelRangeErrorString
Field Value
System.String

OutlineLevelsInRangeProperty

Gets the outline levels within a specified range for the Table of Contents field.

Declaration
public static readonly FieldPropertyDefinition OutlineLevelsInRangeProperty
Field Value
FieldPropertyDefinition

TCEntryProperty

Represents a single entry in a table of contents.

Declaration
public static readonly FieldPropertyDefinition TCEntryProperty
Field Value
FieldPropertyDefinition

TCLevelsInRangeProperty

Gets or sets the levels of a table of contents field that are included in the specified range.

Declaration
public static readonly FieldPropertyDefinition TCLevelsInRangeProperty
Field Value
FieldPropertyDefinition

Properties

AlignmentString

Declaration
[XamlSerializable]
public string AlignmentString { get; set; }
Property Value
System.String

AlignPageNumbers

Gets or sets a valyue that indicated if the page numbers are aligned.

Declaration
[XamlSerializable]
public bool AlignPageNumbers { get; set; }
Property Value
System.Boolean

A bool> value that specifies if the page numbers are aligned.

CaptionName

Declaration
[XamlSerializable]
public string CaptionName { get; set; }
Property Value
System.String

DontShowPageNumbers

Gets or sets a value indicating whether page numbers should be displayed in the table of contents.

Declaration
[XamlSerializable]
public bool DontShowPageNumbers { get; set; }
Property Value
System.Boolean

A boolean value that determines if page numbers are shown. True if page numbers are not shown; otherwise, false.

FieldTypeName

Gets the name of the field type.

Declaration
public override string FieldTypeName { get; }
Property Value
System.String

Overrides

HyperlinkEntries

Gets the collection of hyperlink entries associated with the Table of Contents field.

Declaration
[XamlSerializable]
public bool HyperlinkEntries { get; set; }
Property Value
System.Boolean

IncludeCaptions

Gets or sets a value indicating whether captions should be included in the table of contents.

Declaration
[XamlSerializable]
public bool IncludeCaptions { get; set; }
Property Value
System.Boolean

true if captions should be included; otherwise, false.

IncludeTCEntries

Gets or sets a value indicating whether to include table of contents entries.

Declaration
[XamlSerializable]
public bool IncludeTCEntries { get; set; }
Property Value
System.Boolean

true if the table of contents entries should be included; otherwise, false.

OutlineLevelsInRange

Declaration
[XamlSerializable]
public string OutlineLevelsInRange { get; set; }
Property Value
System.String

TCEntry

Declaration
[XamlSerializable]
public string TCEntry { get; set; }
Property Value
System.String

TCLevelsInRange

Declaration
[XamlSerializable]
public string TCLevelsInRange { get; set; }
Property Value
System.String

UseOutlineLevelsInRange

Gets or sets a value indicating whether to use outline levels for the specified range in the Table of Contents.

Declaration
[XamlSerializable]
public bool UseOutlineLevelsInRange { get; set; }
Property Value
System.Boolean

UseParagraphsOutlineLevels

Gets or sets the outline levels for paragraphs used in the table of contents.

Declaration
[XamlSerializable]
public bool UseParagraphsOutlineLevels { get; set; }
Property Value
System.Boolean

UseTCLevelsInRange

Specifies whether to use the table of contents levels within a specified range.

Declaration
[XamlSerializable]
public bool UseTCLevelsInRange { get; set; }
Property Value
System.Boolean

Methods

BuildCodeOverride()

Builds the field-specific parts of the code fragment, using the current CodeBuilder.

Declaration
protected override void BuildCodeOverride()
Overrides

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

Declaration
public override void CopyPropertiesFrom(Field fromField)
Parameters
Field fromField

The other field, which has to be of the same type as the current instance.
Overrides

CopyPropertiesFromCodeExpression(FieldCodeExpression)

Copies the field-specific properties from a FieldCodeExpression.

Declaration
protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)
Parameters
FieldCodeExpression fieldCodeExpression

The field code expression.
Overrides

CreateInstance()

Creates a new instance of the current field class.

Declaration
public override Field CreateInstance()
Returns
Field

The new field instance.
Overrides

GetResultFragment()

Builds the result fragment of the field.

Declaration
protected override DocumentFragment GetResultFragment()
Returns
DocumentFragment

The result fragment.
Overrides

Extension Methods