New to Telerik UI for WPF? Start a free 30-day trial

TCField

Class

Represents a field in a document model that can contain dynamic values.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

public class TCField : CodeBasedField, ISupportInitialize

Inheritance: objectFieldCodeBasedFieldTCField

Implements: ISupportInitialize

Inherited Members CodeBasedField.DateTimeFormattingPropertyCodeBasedField.GeneralFormattingPropertyCodeBasedField.NumericFormattingPropertyCodeBasedField.ToolTipPropertyCodeBasedField.CopyPropertiesFrom(FieldCodeExpression)CodeBasedField.InvalidateCode()CodeBasedField.GetCodeFragment()CodeBasedField.MakeHyperlinkFragment(DocumentFragment, HyperlinkInfo)CodeBasedField.GetNumberResultWithFormatting(int)CodeBasedField.IsCodeValid()CodeBasedField.CodeBuilderCodeBasedField.FieldCodeCodeBasedField.DateTimeFormattingCodeBasedField.GeneralFormattingCodeBasedField.NumericFormattingCodeBasedField.ToolTipField.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

TCField()

public TCField()

Fields

EntryTextProperty

FieldPropertyDefinition

Represents the text entry of a table of contents field.

public static readonly FieldPropertyDefinition EntryTextProperty

FieldType

string

public static readonly string FieldType

TCLevelProperty

FieldPropertyDefinition

Gets or sets the level of the table of contents field.

public static readonly FieldPropertyDefinition TCLevelProperty

Field Value:

An integer representing the level of the table of contents. The level determines the hierarchy of the entry in the table of contents.

TypeIdentifierProperty

FieldPropertyDefinition

Gets the type identifier of the TCField.

public static readonly FieldPropertyDefinition TypeIdentifierProperty

Properties

EntryText

string

Represents the text entry of a table of contents field.

[XamlSerializable]
public string EntryText { get; set; }

FieldTypeName

string

Gets the name of the field type.

public override string FieldTypeName { get; }

Overrides: Field.FieldTypeName

TCLevel

string

[XamlSerializable]
public string TCLevel { get; set; }

TypeIdentifier

string

Gets the type identifier of the TCField.

[XamlSerializable]
public string TypeIdentifier { get; set; }

UseTCLevel

bool

Gets or sets the level of the table of contents (TOC) field.

[XamlSerializable]
public bool UseTCLevel { get; set; }

Property Value:

The level of the table of contents field. This value determines the hierarchy of the TOC entry.

Methods

BuildCodeOverride()

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

protected override void BuildCodeOverride()

Overrides: CodeBasedField.BuildCodeOverride()

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

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.

protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)

Parameters:fieldCodeExpressionFieldCodeExpression

The field code expression.

Overrides: CodeBasedField.CopyPropertiesFromCodeExpression(FieldCodeExpression)

CreateInstance()

Field

Creates a new instance of the current field class.

public override Field CreateInstance()

Returns:

Field

The new field instance.

Overrides: Field.CreateInstance()

GetResultFragment()

DocumentFragment

Builds the result fragment of the field.

protected override DocumentFragment GetResultFragment()

Returns:

DocumentFragment

The result fragment.

Overrides: Field.GetResultFragment()