Class
DocumentVariableField

Represents a document variable field in the Telerik document model.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition

public class DocumentVariableField : CodeBasedField, ISupportInitialize

Inheritance: objectFieldCodeBasedFieldDocumentVariableField

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

DocumentVariableField()

Declaration

cs-api-definition

public DocumentVariableField()

Fields

FieldType

Declaration

cs-api-definition

public static readonly string FieldType

Field Value

string

VariableNameProperty

Declaration

cs-api-definition

public static readonly FieldPropertyDefinition VariableNameProperty

Field Value

FieldPropertyDefinition

Properties

FieldTypeName

Gets the name of the field type.

Declaration

cs-api-definition

public override string FieldTypeName { get; }

Property Value

string

Overrides Field.FieldTypeName

VariableName

Gets the name of the document variable associated with the field.

Declaration

cs-api-definition

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

Property Value

string

A string representing the name of the document variable. If the variable name has not been set, this property returns null.

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

ConvertValueToString(object)

Converts the specified value to its string representation.

Declaration

cs-api-definition

public static string ConvertValueToString(object value)

Parameters

value

object

The object value to be converted to a string.

Returns

string

A string that represents the converted value.

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

ClassDocumentVariableField

Class
DocumentVariableField