skip navigation
  • Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • NEW: Design Kits for Figma
    • Online Training
    • Document Processing Library
    • Embedded Reporting for web and desktop

    Web

    Kendo UI UI for jQuery UI for Angular UI for React UI for Vue UI for Blazor UI for ASP.NET Core UI for ASP.NET MVC UI for ASP.NET AJAX

    Mobile

    UI for .NET MAUI

    Document Management

    Telerik Document Processing

    Desktop

    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF

    Reporting

    Telerik Reporting Telerik Report Server

    Testing & Mocking

    Test Studio Test Studio Dev Edition Telerik JustMock

    CMS

    Sitefinity

    UI/UX Tools

    ThemeBuilder Design System Kit Templates and Building Blocks

    Debugging

    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Everywhere Reporter FiddlerCore

    Free Tools

    VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
    • What's New
    • Roadmap
    • Release History
  • Support and Learning

    • Support and Learning Hub
    • First Steps
    • Docs
    • Demos
    • Virtual Classroom
    • Forums
    • Videos
    • Blogs
    • Accessibility
    • Submit a Ticket

    Productivity and Design Tools

    • Visual Studio Extensions
    • Visual Studio Templates
    • Embedded Reporting
  • Pricing
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Downloads
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now

Class MergeField

Represents MERGEFIELD.

Inheritance
System.Object
Field
CodeBasedField
MergeField
Inherited Members
CodeBasedField.DateTimeFormattingProperty
CodeBasedField.GeneralFormattingProperty
CodeBasedField.NumericFormattingProperty
CodeBasedField.CopyPropertiesFrom(FieldCodeExpression)
CodeBasedField.InvalidateCode()
CodeBasedField.GetCodeFragment()
CodeBasedField.MakeHyperlinkFragment(DocumentFragment, HyperlinkInfo)
CodeBasedField.GetNumberResultWithFormatting(Int32)
CodeBasedField.IsCodeValid()
CodeBasedField.CodeBuilder
CodeBasedField.FieldCode
CodeBasedField.DateTimeFormatting
CodeBasedField.GeneralFormatting
CodeBasedField.NumericFormatting
Field.CodeFragmentFormat
Field.DisplayNameFragmentFormat
Field.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.FieldStart
Field.DisplayMode
Field.EvaluationContext
Field.Document
Field.FieldPropertySetters
Namespace: Telerik.Windows.Documents.Model
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public class MergeField : CodeBasedField, ISupportInitialize

Constructors

MergeField()

Initializes a new instance of the MergeField class.

Declaration
public MergeField()

Fields

FieldType

The field type.

Declaration
public static readonly string FieldType
Field Value
System.String

PropertyPathProperty

Declaration
public static readonly FieldPropertyDefinition PropertyPathProperty
Field Value
FieldPropertyDefinition

TextAfterIfNotEmptyProperty

Declaration
public static readonly FieldPropertyDefinition TextAfterIfNotEmptyProperty
Field Value
FieldPropertyDefinition

TextBeforeIfNotEmptyProperty

Declaration
public static readonly FieldPropertyDefinition TextBeforeIfNotEmptyProperty
Field Value
FieldPropertyDefinition

Properties

FieldTypeName

Gets the name of the field type.

Declaration
public override string FieldTypeName { get; }
Property Value
System.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
public override bool HasDisplayNameFragment { get; }
Property Value
System.Boolean

Overrides
Field.HasDisplayNameFragment

PropertyPath

Gets or sets the property associated with this instance.

Declaration
[XamlSerializable]
public string PropertyPath { get; set; }
Property Value
System.String

The property path/name.

TextAfterIfNotEmpty

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

Declaration
[XamlSerializable]
public string TextAfterIfNotEmpty { get; set; }
Property Value
System.String

The text.

TextBeforeIfNotEmpty

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

Declaration
[XamlSerializable]
public string TextBeforeIfNotEmpty { get; set; }
Property Value
System.String

The text.

Methods

BuildCodeOverride()

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

Declaration
protected override void BuildCodeOverride()
Overrides
CodeBasedField.BuildCodeOverride()

ConvertToString(Object)

Converts a value to string.

Declaration
protected virtual string ConvertToString(object value)
Parameters
System.Object value

The value.

Returns
System.String

The string representation of the value.

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

Declaration
public override void CopyPropertiesFrom(Field fromField)
Parameters
Field fromField

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
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
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
protected override DocumentFragment GetDisplayNameFragment()
Returns
DocumentFragment

The display name fragment.

Overrides
Field.GetDisplayNameFragment()

GetResultFragment()

Builds the result fragment of the field.

Declaration
protected override DocumentFragment GetResultFragment()
Returns
DocumentFragment

The result fragment.

Overrides
Field.GetResultFragment()

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)
EnumerableExtensions.ToEnumerable<T>(T)

See Also

CodeBasedField
Getting Started
  • Install Now
  • Demos
  • SDK Samples Browser
  • Sample Applications
Support Resources
  • Code Library
  • Knowledge Base
  • MVVM Support
  • Videos
  • GitHub SDK Repository
Community
  • Forums
  • Blogs
  • XAML Feedback Portal
  • Document Processing Feedback Portal

Copyright © 2018 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.