RichEditControl.CustomizeMergeFields Event

Fires when the ‘Insert Merge Field’ command button is clicked, and enables you to customize a drop-down field list.

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v18.2.dll

Declaration

C#

public event CustomizeMergeFieldsEventHandler CustomizeMergeFields

VB.NET

Public Event CustomizeMergeFields As CustomizeMergeFieldsEventHandler

Event Data

The CustomizeMergeFields event's data class is CustomizeMergeFieldsEventArgs. The following properties provide information specific to this event:

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

Remarks

Use the CustomizeMergeFieldsEventArgs.MergeFieldsNames property, to specify fields and field names to show in the drop-down list.

See the Simple Data Merge Demo for an example of use.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomizeMergeFields event.

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#

how-to-customize-the-merge-field-collection-and-perform-mail-merge-using-the-ilist-data-so-t532297/CS/SimpleDataMerge/MainWindow.xaml#L18

<dxre:RichEditControl x:Name="richEdit" CommandBarStyle="Ribbon" ShowBorder="False"
                          CustomizeMergeFields="OnRichEditCustomizeMergeFields"
                          DocumentSource="MailMergeSimple.rtf">