Class
TableOfContentsField

Definition

Namespace:Telerik.WinForms.Documents.Model

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

cs-api-definition
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()

Declaration

cs-api-definition
public TableOfContentsField()

Fields

AlignmentStringProperty

Declaration

cs-api-definition
public static readonly FieldPropertyDefinition AlignmentStringProperty

Field Value

FieldPropertyDefinition

CaptionNameProperty

Declaration

cs-api-definition
public static readonly FieldPropertyDefinition CaptionNameProperty

Field Value

FieldPropertyDefinition

DefaultAlignmentString

Declaration

cs-api-definition
public static readonly string DefaultAlignmentString

Field Value

string

ErrorString

Declaration

cs-api-definition
public static readonly string ErrorString

Field Value

string

FieldType

Declaration

cs-api-definition
public static readonly string FieldType

Field Value

string

InvalidHeadingLevelRangeErrorString

Declaration

cs-api-definition
public static readonly string InvalidHeadingLevelRangeErrorString

Field Value

string

OutlineLevelsInRangeProperty

Declaration

cs-api-definition
public static readonly FieldPropertyDefinition OutlineLevelsInRangeProperty

Field Value

FieldPropertyDefinition

TCEntryProperty

Declaration

cs-api-definition
public static readonly FieldPropertyDefinition TCEntryProperty

Field Value

FieldPropertyDefinition

TCLevelsInRangeProperty

Declaration

cs-api-definition
public static readonly FieldPropertyDefinition TCLevelsInRangeProperty

Field Value

FieldPropertyDefinition

Properties

AlignPageNumbers

Declaration

cs-api-definition
[XamlSerializable]
public bool AlignPageNumbers { get; set; }

Property Value

bool

AlignmentString

Declaration

cs-api-definition
[XamlSerializable]
public string AlignmentString { get; set; }

Property Value

string

CaptionName

Declaration

cs-api-definition
[XamlSerializable]
public string CaptionName { get; set; }

Property Value

string

DontShowPageNumbers

Declaration

cs-api-definition
[XamlSerializable]
public bool DontShowPageNumbers { get; set; }

Property Value

bool

FieldTypeName

Gets the name of the field type.

Declaration

cs-api-definition
public override string FieldTypeName { get; }

Property Value

string

Overrides Field.FieldTypeName

HyperlinkEntries

Declaration

cs-api-definition
[XamlSerializable]
public bool HyperlinkEntries { get; set; }

Property Value

bool

IncludeCaptions

Declaration

cs-api-definition
[XamlSerializable]
public bool IncludeCaptions { get; set; }

Property Value

bool

IncludeTCEntries

Declaration

cs-api-definition
[XamlSerializable]
public bool IncludeTCEntries { get; set; }

Property Value

bool

OutlineLevelsInRange

Declaration

cs-api-definition
[XamlSerializable]
public string OutlineLevelsInRange { get; set; }

Property Value

string

TCEntry

Declaration

cs-api-definition
[XamlSerializable]
public string TCEntry { get; set; }

Property Value

string

TCLevelsInRange

Declaration

cs-api-definition
[XamlSerializable]
public string TCLevelsInRange { get; set; }

Property Value

string

UseOutlineLevelsInRange

Declaration

cs-api-definition
[XamlSerializable]
public bool UseOutlineLevelsInRange { get; set; }

Property Value

bool

UseParagraphsOutlineLevels

Declaration

cs-api-definition
[XamlSerializable]
public bool UseParagraphsOutlineLevels { get; set; }

Property Value

bool

UseTCLevelsInRange

Declaration

cs-api-definition
[XamlSerializable]
public bool UseTCLevelsInRange { get; set; }

Property Value

bool

Methods

BuildCodeOverride()

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

Declaration

cs-api-definition
protected override void BuildCodeOverride()

Overrides CodeBasedField.BuildCodeOverride()

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

Declaration

cs-api-definition
public override void CopyPropertiesFrom(Field fromField)

Parameters

fromField

Field

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.

Declaration

cs-api-definition
protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)

Parameters

fieldCodeExpression

FieldCodeExpression

The field code expression.

Overrides CodeBasedField.CopyPropertiesFromCodeExpression(FieldCodeExpression)

CreateInstance()

Creates a new instance of the current field class.

Declaration

cs-api-definition
public override Field CreateInstance()

Returns

Field

The new field instance.

Overrides Field.CreateInstance()

GetResultFragment()

Builds the result fragment of the field.

Declaration

cs-api-definition
protected override DocumentFragment GetResultFragment()

Returns

DocumentFragment

The result fragment.

Overrides Field.GetResultFragment()