ClassTableOfContentsField
Represents a field that generates a table of contents in a document.
Definition
Namespace:Telerik.Windows.Documents.Model
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public class TableOfContentsField : CodeBasedField, ISupportInitializeInheritance: objectFieldCodeBasedFieldTableOfContentsField
Implements:
Inherited Members
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 AlignmentStringPropertyField Value
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 CaptionNamePropertyField Value
DefaultAlignmentString
Declaration
public static readonly string DefaultAlignmentStringField Value
InvalidHeadingLevelRangeErrorString
Declaration
public static readonly string InvalidHeadingLevelRangeErrorStringField Value
OutlineLevelsInRangeProperty
Gets the outline levels within a specified range for the Table of Contents field.
Declaration
public static readonly FieldPropertyDefinition OutlineLevelsInRangePropertyField Value
TCEntryProperty
Represents a single entry in a table of contents.
Declaration
public static readonly FieldPropertyDefinition TCEntryPropertyField Value
TCLevelsInRangeProperty
Gets or sets the levels of a table of contents field that are included in the specified range.
Declaration
public static readonly FieldPropertyDefinition TCLevelsInRangePropertyField Value
Properties
AlignPageNumbers
Gets or sets a valyue that indicated if the page numbers are aligned.
Declaration
[XamlSerializable]
public bool AlignPageNumbers { get; set; }Property Value
A bool> value that specifies if the page numbers are aligned.
AlignmentString
Declaration
[XamlSerializable]
public string AlignmentString { get; set; }Property Value
CaptionName
Declaration
[XamlSerializable]
public string CaptionName { get; set; }Property Value
DontShowPageNumbers
Gets or sets a value indicating whether page numbers should be displayed in the table of contents.
Declaration
[SuppressMessage("Microsoft.Naming", "CA1726:UsePreferredTerms", MessageId = "Dont")]
[XamlSerializable]
public bool DontShowPageNumbers { get; set; }Property Value
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
Overrides
HyperlinkEntries
Gets the collection of hyperlink entries associated with the Table of Contents field.
Declaration
[XamlSerializable]
public bool HyperlinkEntries { get; set; }Property Value
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
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
true if the table of contents entries should be included; otherwise, false.
OutlineLevelsInRange
Declaration
[XamlSerializable]
public string OutlineLevelsInRange { get; set; }Property Value
TCEntry
Declaration
[XamlSerializable]
public string TCEntry { get; set; }Property Value
TCLevelsInRange
Declaration
[XamlSerializable]
public string TCLevelsInRange { get; set; }Property Value
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
UseParagraphsOutlineLevels
Gets or sets the outline levels for paragraphs used in the table of contents.
Declaration
[XamlSerializable]
public bool UseParagraphsOutlineLevels { get; set; }Property Value
UseTCLevelsInRange
Specifies whether to use the table of contents levels within a specified range.
Declaration
[XamlSerializable]
public bool UseTCLevelsInRange { get; set; }Property Value
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
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
The field code expression.
Overrides
CreateInstance()
Creates a new instance of the current field class.
Declaration
public override Field CreateInstance()Returns
The new field instance.
Overrides
GetResultFragment()
Builds the result fragment of the field.
Declaration
protected override DocumentFragment GetResultFragment()Returns
The result fragment.
Overrides