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

DocumentVariableField

Class

Represents a document variable field in the Telerik document model.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

public class DocumentVariableField : CodeBasedField, ISupportInitialize

Inheritance: objectFieldCodeBasedFieldDocumentVariableField

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

DocumentVariableField()

public DocumentVariableField()

Fields

FieldType

string

public static readonly string FieldType

VariableNameProperty

FieldPropertyDefinition

public static readonly FieldPropertyDefinition VariableNameProperty

Properties

FieldTypeName

string

Gets the name of the field type.

public override string FieldTypeName { get; }

Overrides: Field.FieldTypeName

VariableName

string

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

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

Property Value:

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.

protected override void BuildCodeOverride()

Overrides: CodeBasedField.BuildCodeOverride()

ConvertValueToString(object)

string

Converts the specified value to its string representation.

public static string ConvertValueToString(object value)

Parameters:valueobject

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.

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