TCField
Marks content as a table-of-contents entry and supplies its optional display text, type identifier, and level.
Definition
Namespace:Telerik.WinForms.Documents.Model
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class TCField : CodeBasedField, ISupportInitialize
Inheritance: objectFieldCodeBasedFieldTCField
Implements:
Inherited Members
Constructors
Creates a TC field with an empty result; its values are consumed when a table of contents is generated.
public TCField()
Fields
Identifies the field property that stores the entry's display text.
public static readonly FieldPropertyDefinition EntryTextProperty
Identifies the field property that stores the entry's TC level.
public static readonly FieldPropertyDefinition TCLevelProperty
Identifies the field property that stores the entry's type identifier.
public static readonly FieldPropertyDefinition TypeIdentifierProperty
Properties
Gets or sets replacement text for this table-of-contents entry; when empty, the marked document content is used.
[XamlSerializable]
public string EntryText { get; set; }
Gets the name of the field type.
public override string FieldTypeName { get; }
Overrides:
Gets or sets the level argument emitted when UseTCLevel is enabled. Table-of-contents fields can use this value to filter or style the entry.
[XamlSerializable]
public string TCLevel { get; set; }
Gets or sets the type identifier that a table-of-contents field can use to filter this entry.
[XamlSerializable]
public string TypeIdentifier { get; set; }
Gets or sets whether a TC-level switch is included in the field code.
[XamlSerializable]
public bool UseTCLevel { 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: