RichEditMailMergeOptions.DataMember Property

Specifies the member of a mail merge document‘s data source.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

[DefaultValue("")]
public virtual string DataMember { get; set; }

VB.NET

<DefaultValue("")>
Public Overridable Property DataMember As String

Property Value

Type	Default	Description
String	String.Empty	The data member name.

Property Paths

You can access this nested property as listed below:

Object Type	Path to DataMember
RichEditControlOptionsBase	.MailMerge .DataMember

Remarks

Specify the DataMember property if a dataset used in a mail merge data source (set as the RichEditMailMergeOptions.DataSource property value) contains multiple data tables.

The DataMember is ignored when the document data source is a data table, data view, or a custom object.

Related GitHub Examples

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

word-document-api-create-master-detail-report/CS/MasterDetailExample/MergeProcessor.cs#L44

productRichEdit.Options.MailMerge.DataSource = ds;
productRichEdit.Options.MailMerge.DataMember = "Products";

winforms-richedit-customize-insert-merge-field-menu/CS/CustomInsertMergeFieldItem.cs#L67

RichEditMailMergeOptions mailMergeOptions = RichEditControl.Options.MailMerge;
DataBindingController mergeFieldsController = new DataBindingController(mailMergeOptions.DataSource, mailMergeOptions.DataMember);
List<string> columnNames = mergeFieldsController.ColumnNames;

VB.NET

word-document-api-create-master-detail-report/VB/MasterDetailExample/MergeProcessor.vb#L43

productRichEdit.Options.MailMerge.DataSource = ds
productRichEdit.Options.MailMerge.DataMember = "Products"
ordersRichEdit.LoadDocument("detaildetail.rtf")

winforms-richedit-customize-insert-merge-field-menu/VB/CustomInsertMergeFieldItem.vb#L119

Dim mailMergeOptions As RichEditMailMergeOptions = RichEditControl.Options.MailMerge
Dim mergeFieldsController As DataBindingController = New DataBindingController(mailMergeOptions.DataSource, mailMergeOptions.DataMember)
Dim columnNames As List(Of String) = mergeFieldsController.ColumnNames