RichEditMailMergeOptions.DataSource Property

Specifies the data source of a mail merge document.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

[DefaultValue(null)]
public virtual object DataSource { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Overridable Property DataSource As Object

Property Value

Type	Default	Description
Object	null	The data source.

Property Paths

You can access this nested property as listed below:

Object Type	Path to DataSource
RichEditControlOptionsBase	.MailMerge .DataSource

Remarks

The following data source types are available:

• System.Collections.IList
• System.Collections.ArrayList
• System.Data.DataTable

When a data source contains multiple data tables, use the RichEditMailMergeOptions.DataMember property to specify the required data member.

Example

The code sample below shows how to use the XML data source:

C#

using DevExpress.XtraRichEdit;
using System.Data;

DataSet xmlDataSet = new DataSet();
xmlDataSet.ReadXml("Employees.xml");
xmlDataSet.Tables[0].PrimaryKey = new DataColumn[] {
     xmlDataSet.Tables[0].Columns[0] };

using (var wordProcessor = new RichEditDocumentServer())
{
    wordProcessor.Options.MailMerge.DataSource = xmlDataSet.Tables[0];
    //...
}

VB.NET

Imports DevExpress.XtraRichEdit
Imports System.Data

Private xmlDataSet As New DataSet()
xmlDataSet.ReadXml("Employees.xml")
xmlDataSet.Tables(0).PrimaryKey = New DataColumn() { xmlDataSet.Tables(0).Columns(0) }

Using wordProcessor = New RichEditDocumentServer()
    wordProcessor.Options.MailMerge.DataSource = xmlDataSet.Tables[0]
    '...
End Using

Related GitHub Examples

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

suppllierRichEdit.LoadDocument("supplier.rtf");
suppllierRichEdit.Options.MailMerge.DataSource = ds;

winforms-richedit-create-a-master-detail-report/CS/RichEditMasterDetailMailMerge/Form1.cs#L62

//so provide it with a mock data.
mainRichEdit.Options.MailMerge.DataSource = CreateFakeDataSource();

winforms-richedit-utility-to-create-a-mail-merge-template/CS/Form1.cs#L60

    CreateDefaultData(dataTable);
    richEditControl1.Options.MailMerge.DataSource = dataTable;
}

winforms-richedit-master-detail-mail-merge-essentials/CS/Form1.cs#L20

private void performMailMergeItem_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
    richEditCategoryTemplate.Options.MailMerge.DataSource = NorthwindDataProvider.Categories;

winforms-richedit-customize-insert-merge-field-menu/CS/Form1.cs#L14

    richEditControl1.Options.MailMerge.DataSource = GetMailMergeData();
}

VB.NET

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

suppllierRichEdit.LoadDocument("supplier.rtf")
suppllierRichEdit.Options.MailMerge.DataSource = ds
productRichEdit.LoadDocument("detail.rtf")

winforms-richedit-create-a-master-detail-report/VB/RichEditMasterDetailMailMerge/Form1.vb#L58

'so provide it with a mock data:
mainRichEdit.Options.MailMerge.DataSource = CreateFakeDataSource()

winforms-richedit-utility-to-create-a-mail-merge-template/VB/Form1.vb#L62

    CreateDefaultData(dataTable)
    richEditControl1.Options.MailMerge.DataSource = dataTable
End Sub

winforms-richedit-master-detail-mail-merge-essentials/VB/Form1.vb#L20

Private Sub performMailMergeItem_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs)
    richEditCategoryTemplate.Options.MailMerge.DataSource = Categories
    Dim mailMergeOptions As MailMergeOptions = richEditCategoryTemplate.CreateMailMergeOptions()

winforms-richedit-customize-insert-merge-field-menu/VB/Form1.vb#L14

    InitializeComponent()
    richEditControl1.Options.MailMerge.DataSource = GetMailMergeData()
End Sub