Class
MergeField

Represents MERGEFIELD.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition

public class MergeField : CodeBasedField, ISupportInitialize

Inheritance: objectFieldCodeBasedFieldMergeField

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.CreateDeepCopy()Field.SetPropertyValue(FieldPropertyDefinition, string)Field.SetPropertyValue(FieldPropertyDefinition, Field)Field.IsResultFragmentEmpty()Field.FieldStartField.DisplayModeField.EvaluationContextField.Document

Constructors

MergeField()

Initializes a new instance of the MergeField class.

Declaration

cs-api-definition

public MergeField()

Fields

FieldType

The field type.

Declaration

cs-api-definition

public static readonly string FieldType

Field Value

string

PropertyPathProperty

Declaration

cs-api-definition

public static readonly FieldPropertyDefinition PropertyPathProperty

Field Value

FieldPropertyDefinition

TextAfterIfNotEmptyProperty

Declaration

cs-api-definition

public static readonly FieldPropertyDefinition TextAfterIfNotEmptyProperty

Field Value

FieldPropertyDefinition

TextBeforeIfNotEmptyProperty

Declaration

cs-api-definition

public static readonly FieldPropertyDefinition TextBeforeIfNotEmptyProperty

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

HasDisplayNameFragment

Gets the value indicating whether the field type has a display name fragment. If it doesn't, when its display mode is set to display name, the result fragment will be used instead.

Declaration

cs-api-definition

public override bool HasDisplayNameFragment { get; }

Property Value

bool

Overrides Field.HasDisplayNameFragment

PropertyPath

Gets or sets the property associated with this instance.

Declaration

cs-api-definition

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

Property Value

string

The property path/name.

TextAfterIfNotEmpty

Gets or sets the text after the field result, used when the latter is not empty.

Declaration

cs-api-definition

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

Property Value

string

The text.

TextBeforeIfNotEmpty

Gets or sets the text before the field result, used when the latter is not empty.

Declaration

cs-api-definition

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

Property Value

string

The text.

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

ConvertToString(object)

Converts a value to string.

Declaration

cs-api-definition

protected virtual string ConvertToString(object value)

Parameters

value

object

The value.

Returns

string

The string representation of the 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()

GetDisplayNameFragment()

Gets the display name fragment of the field if the field has such.

Declaration

cs-api-definition

protected override DocumentFragment GetDisplayNameFragment()

Returns

DocumentFragment

The display name fragment.

Overrides Field.GetDisplayNameFragment()

GetResultFragment()

Builds the result fragment of the field.

Declaration

cs-api-definition

protected override DocumentFragment GetResultFragment()

Returns

DocumentFragment

The result fragment.

Overrides Field.GetResultFragment()

ClassMergeField

Class
MergeField