TableOfContentsField
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
public TableOfContentsField()Fields
Gets or sets the string representation of the alignment for the Table of Contents field.
public static readonly FieldPropertyDefinition AlignmentStringPropertyA string value that specifies the alignment, which can include options such as "Left", "Center", and "Right".
Gets the name of the caption for the table of contents field.
public static readonly FieldPropertyDefinition CaptionNamePropertypublic static readonly string DefaultAlignmentStringpublic static readonly string ErrorStringpublic static readonly string InvalidHeadingLevelRangeErrorStringGets the outline levels within a specified range for the Table of Contents field.
public static readonly FieldPropertyDefinition OutlineLevelsInRangePropertyRepresents a single entry in a table of contents.
public static readonly FieldPropertyDefinition TCEntryPropertyGets or sets the levels of a table of contents field that are included in the specified range.
public static readonly FieldPropertyDefinition TCLevelsInRangePropertyProperties
[XamlSerializable]
public string AlignmentString { get; set; }Gets or sets a valyue that indicated if the page numbers are aligned.
[XamlSerializable]
public bool AlignPageNumbers { get; set; }A bool> value that specifies if the page numbers are aligned.
[XamlSerializable]
public string CaptionName { get; set; }Gets or sets a value indicating whether page numbers should be displayed in the table of contents.
[XamlSerializable]
public bool DontShowPageNumbers { get; set; }A boolean value that determines if page numbers are shown. True if page numbers are not shown; otherwise, false.
Gets the name of the field type.
public override string FieldTypeName { get; }Overrides:
Gets the collection of hyperlink entries associated with the Table of Contents field.
[XamlSerializable]
public bool HyperlinkEntries { get; set; }Gets or sets a value indicating whether captions should be included in the table of contents.
[XamlSerializable]
public bool IncludeCaptions { get; set; }true if captions should be included; otherwise, false.
Gets or sets a value indicating whether to include table of contents entries.
[XamlSerializable]
public bool IncludeTCEntries { get; set; }true if the table of contents entries should be included; otherwise, false.
[XamlSerializable]
public string OutlineLevelsInRange { get; set; }[XamlSerializable]
public string TCLevelsInRange { get; set; }Gets or sets a value indicating whether to use outline levels for the specified range in the Table of Contents.
[XamlSerializable]
public bool UseOutlineLevelsInRange { get; set; }Gets or sets the outline levels for paragraphs used in the table of contents.
[XamlSerializable]
public bool UseParagraphsOutlineLevels { get; set; }Specifies whether to use the table of contents levels within a specified range.
[XamlSerializable]
public bool UseTCLevelsInRange { get; set; }Methods
Builds the field-specific parts of the code fragment, using the current CodeBuilder.
protected override void BuildCodeOverride()Overrides:
Copies all properties from another field of the same type.
public override void CopyPropertiesFrom(Field fromField)The other field, which has to be of the same type as the current instance.
Overrides:
Copies the field-specific properties from a FieldCodeExpression.
protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)The field code expression.
Overrides:
Creates a new instance of the current field class.
Builds the result fragment of the field.
protected override DocumentFragment GetResultFragment()The result fragment.
Overrides: