CustomizeMergeFieldsEventArgs.MergeFieldsNames Property

Gets or sets a list of fields shown by the InsertMergeField command with their display names.

Namespace: DevExpress.XtraRichEdit

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

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

Declaration

C#

public MergeFieldName[] MergeFieldsNames { get; set; }

VB.NET

Public Property MergeFieldsNames As MergeFieldName()

Property Value

Type	Description
MergeFieldName[]	An array of MergeFieldName objects.

Remarks

Handle the RichEditControl.CustomizeMergeFields event and use the MergeFieldsNames property to change display names of mail merge fields or simply to hide unwanted fields.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the MergeFieldsNames 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#

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

private void richEditControl1_CustomizeMergeFields(object sender, DevExpress.XtraRichEdit.CustomizeMergeFieldsEventArgs e) {
    List<MergeFieldName> mergeFieldNames = new List<MergeFieldName>(e.MergeFieldsNames);

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

foreach (var field in e.MergeFieldsNames)
{

VB.NET

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

Private Sub richEditControl1_CustomizeMergeFields(ByVal sender As Object, ByVal e As DevExpress.XtraRichEdit.CustomizeMergeFieldsEventArgs)
    Dim mergeFieldNames As List(Of MergeFieldName) = New List(Of MergeFieldName)(e.MergeFieldsNames)
    mergeFieldNames.Remove(mergeFieldNames.Find(Function(mfn) Equals(mfn.Name.ToLower(), "password")))

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

Protected Sub RE_CustomizeMergeFields(ByVal sender As Object, ByVal e As DevExpress.XtraRichEdit.CustomizeMergeFieldsEventArgs)
    For Each field In e.MergeFieldsNames
        If Equals(field.Name, "ProductID") Then