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

MergeField

Class

Represents MERGEFIELD.

Definition

Namespace:Telerik.WinForms.Documents.Model

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

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.

public MergeField()

Fields

FieldType

string

The field type.

public static readonly string FieldType

PropertyPathProperty

FieldPropertyDefinition

public static readonly FieldPropertyDefinition PropertyPathProperty

TextAfterIfNotEmptyProperty

FieldPropertyDefinition

public static readonly FieldPropertyDefinition TextAfterIfNotEmptyProperty

TextBeforeIfNotEmptyProperty

FieldPropertyDefinition

public static readonly FieldPropertyDefinition TextBeforeIfNotEmptyProperty

Properties

FieldTypeName

string

Gets the name of the field type.

public override string FieldTypeName { get; }

Overrides: Field.FieldTypeName

HasDisplayNameFragment

bool

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.

public override bool HasDisplayNameFragment { get; }

Overrides: Field.HasDisplayNameFragment

PropertyPath

string

Gets or sets the property associated with this instance.

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

Property Value:

The property path/name.

TextAfterIfNotEmpty

string

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

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

Property Value:

The text.

TextBeforeIfNotEmpty

string

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

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

Property Value:

The text.

Methods

BuildCodeOverride()

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

protected override void BuildCodeOverride()

Overrides: CodeBasedField.BuildCodeOverride()

ConvertToString(object)

Converts a value to string.

protected virtual string ConvertToString(object value)

Parameters:valueobject

The value.

Returns:

string

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

Creates a new instance of the current field class.

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.

protected override DocumentFragment GetDisplayNameFragment()

Returns:

DocumentFragment

The display name fragment.

Overrides: Field.GetDisplayNameFragment()

GetResultFragment()

Builds the result fragment of the field.

protected override DocumentFragment GetResultFragment()

Returns:

DocumentFragment

The result fragment.

Overrides: Field.GetResultFragment()