MergeFieldName.DisplayName Property

Gets or sets the name of the field for display in a drop-down list of merged fields available in a Rich Editor’s bar or Ribbon UI.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

public string DisplayName { get; set; }

VB.NET

Public Property DisplayName As String

Property Value

Type	Description
String	A string that is the display name of the field.

Remarks

The DisplayName specifies an informative, descriptive name used to create a mail merge template. This name is used by the InsertMergeFieldCommand command to construct a drop-down list in editor’s bar or Ribbon UI.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DisplayName property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

web-forms-customize-merge-field-names/CS/handle-customizemergefields-event/Default.aspx.cs#L25

{
    if (field.Name == "ProductID") field.DisplayName = "ID of Product";
    else if (field.Name == "ProductName") field.DisplayName = "Name of Product";

winforms-richedit-customize-merge-fields/CS/Form1.cs#L31

private static void ChangeDisplayName(MergeFieldName mfn) {
    mfn.DisplayName += " (field)";
}

VB.NET

web-forms-customize-merge-field-names/VB/handle-customizemergefields-event/Default.aspx.vb#L19

If Equals(field.Name, "ProductID") Then
    field.DisplayName = "ID of Product"
ElseIf Equals(field.Name, "ProductName") Then

winforms-richedit-customize-merge-fields/VB/Form1.vb#L29

Private Shared Sub ChangeDisplayName(ByVal mfn As MergeFieldName)
    mfn.DisplayName += " (field)"
End Sub