Class
TCField

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:

cs-api-definition

public class TCField : CodeBasedField, ISupportInitialize

Inheritance: objectFieldCodeBasedFieldTCField

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

TCField()

Declaration

cs-api-definition

public TCField()

Fields

EntryTextProperty

Represents the text entry of a table of contents field.

Declaration

cs-api-definition

public static readonly FieldPropertyDefinition EntryTextProperty

Field Value

FieldPropertyDefinition

FieldType

Declaration

cs-api-definition

public static readonly string FieldType

Field Value

string

TCLevelProperty

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

Declaration

cs-api-definition

public static readonly FieldPropertyDefinition TCLevelProperty

Field Value

FieldPropertyDefinition

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

TypeIdentifierProperty

Gets the type identifier of the TCField.

Declaration

cs-api-definition

public static readonly FieldPropertyDefinition TypeIdentifierProperty

Field Value

FieldPropertyDefinition

Properties

EntryText

Represents the text entry of a table of contents field.

Declaration

cs-api-definition

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

Property Value

string

FieldTypeName

Gets the name of the field type.

Declaration

cs-api-definition

public override string FieldTypeName { get; }

Property Value

string

Overrides Field.FieldTypeName

TCLevel

Declaration

cs-api-definition

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

Property Value

string

TypeIdentifier

Gets the type identifier of the TCField.

Declaration

cs-api-definition

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

Property Value

string

UseTCLevel

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

Declaration

cs-api-definition

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

Property Value

bool

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.

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()

ClassTCField

Class
TCField