Back to all docs
API Reference / Telerik.WinForms.Documents.Model / TableOfContentsField
New to Telerik UI for WinForms? Start a free 30-day trial

TableOfContentsField

Class

Definition

Namespace:Telerik.WinForms.Documents.Model

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:
C#
public class TableOfContentsField : CodeBasedField, ISupportInitialize

Inheritance: objectFieldCodeBasedFieldTableOfContentsField

Implements: ISupportInitialize

Inherited Members CodeBasedField.DateTimeFormattingPropertyCodeBasedField.GeneralFormattingPropertyCodeBasedField.NumericFormattingPropertyCodeBasedField.CopyPropertiesFrom(FieldCodeExpression)CodeBasedField.InvalidateCode()CodeBasedField.GetCodeFragment()CodeBasedField.MakeHyperlinkFragment(DocumentFragment, HyperlinkInfo)CodeBasedField.GetNumberResultWithFormatting(int)CodeBasedField.IsCodeValid()CodeBasedField.CodeBuilderCodeBasedField.FieldCodeCodeBasedField.DateTimeFormattingCodeBasedField.GeneralFormattingCodeBasedField.NumericFormattingField.CodeFragmentFormatField.DisplayNameFragmentFormatField.GetFragmentToDisplay()Field.GetFragmentByDisplayMode(FieldDisplayMode)Field.SetFragmentByDisplayMode(FieldDisplayMode, DocumentFragment)Field.Update()Field.CreateFragmentFromText(string)Field.GetDisplayNameFragment()Field.CreateDeepCopy()Field.SetPropertyValue(FieldPropertyDefinition, string)Field.SetPropertyValue(FieldPropertyDefinition, Field)Field.IsResultFragmentEmpty()Field.HasDisplayNameFragmentField.FieldStartField.DisplayModeField.EvaluationContextField.Document...

Constructors

TableOfContentsField()

C#
public TableOfContentsField()

Fields

AlignmentStringProperty

C#
public static readonly FieldPropertyDefinition AlignmentStringProperty

CaptionNameProperty

C#
public static readonly FieldPropertyDefinition CaptionNameProperty

DefaultAlignmentString

C#
public static readonly string DefaultAlignmentString

ErrorString

C#
public static readonly string ErrorString

FieldType

C#
public static readonly string FieldType

InvalidHeadingLevelRangeErrorString

C#
public static readonly string InvalidHeadingLevelRangeErrorString

OutlineLevelsInRangeProperty

C#
public static readonly FieldPropertyDefinition OutlineLevelsInRangeProperty

TCEntryProperty

C#
public static readonly FieldPropertyDefinition TCEntryProperty

TCLevelsInRangeProperty

C#
public static readonly FieldPropertyDefinition TCLevelsInRangeProperty

Properties

AlignmentString

C#
[XamlSerializable]
public string AlignmentString { get; set; }

AlignPageNumbers

C#
[XamlSerializable]
public bool AlignPageNumbers { get; set; }

CaptionName

C#
[XamlSerializable]
public string CaptionName { get; set; }

DontShowPageNumbers

C#
[XamlSerializable]
public bool DontShowPageNumbers { get; set; }

FieldTypeName

Gets the name of the field type.

C#
public override string FieldTypeName { get; }

Overrides: Field.FieldTypeName

HyperlinkEntries

C#
[XamlSerializable]
public bool HyperlinkEntries { get; set; }

IncludeCaptions

C#
[XamlSerializable]
public bool IncludeCaptions { get; set; }

IncludeTCEntries

C#
[XamlSerializable]
public bool IncludeTCEntries { get; set; }

OutlineLevelsInRange

C#
[XamlSerializable]
public string OutlineLevelsInRange { get; set; }

TCEntry

C#
[XamlSerializable]
public string TCEntry { get; set; }

TCLevelsInRange

C#
[XamlSerializable]
public string TCLevelsInRange { get; set; }

UseOutlineLevelsInRange

C#
[XamlSerializable]
public bool UseOutlineLevelsInRange { get; set; }

UseParagraphsOutlineLevels

C#
[XamlSerializable]
public bool UseParagraphsOutlineLevels { get; set; }

UseTCLevelsInRange

C#
[XamlSerializable]
public bool UseTCLevelsInRange { get; set; }

Methods

BuildCodeOverride()

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

C#
protected override void BuildCodeOverride()

Overrides: CodeBasedField.BuildCodeOverride()

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

C#
public override void CopyPropertiesFrom(Field fromField)
Parameters:fromFieldField

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

Overrides: CodeBasedField.CopyPropertiesFrom(Field)

CopyPropertiesFromCodeExpression(FieldCodeExpression)

Copies the field-specific properties from a FieldCodeExpression.

C#
protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)
Parameters:fieldCodeExpressionFieldCodeExpression

The field code expression.

Overrides: CodeBasedField.CopyPropertiesFromCodeExpression(FieldCodeExpression)

CreateInstance()

Creates a new instance of the current field class.

C#
public override Field CreateInstance()
Returns:

Field

The new field instance.

Overrides: Field.CreateInstance()

GetResultFragment()

Builds the result fragment of the field.

C#
protected override DocumentFragment GetResultFragment()
Returns:

DocumentFragment

The result fragment.

Overrides: Field.GetResultFragment()

In this article
DefinitionConstructorsTableOfContentsField()FieldsAlignmentStringPropertyCaptionNamePropertyDefaultAlignmentStringErrorStringFieldTypeInvalidHeadingLevelRangeErrorStringOutlineLevelsInRangePropertyTCEntryPropertyTCLevelsInRangePropertyPropertiesAlignmentStringAlignPageNumbersCaptionNameDontShowPageNumbersFieldTypeNameHyperlinkEntriesIncludeCaptionsIncludeTCEntriesOutlineLevelsInRangeTCEntryTCLevelsInRangeUseOutlineLevelsInRangeUseParagraphsOutlineLevelsUseTCLevelsInRangeMethodsBuildCodeOverride()CopyPropertiesFrom(Field)CopyPropertiesFromCodeExpression(FieldCodeExpression)CreateInstance()GetResultFragment()
Not finding the help you need?
Contact Support