MailMergeOptions.DataSource Property

Gets or sets the data source for the mail merge.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

object DataSource { get; set; }

VB.NET

Property DataSource As Object

Property Value

Type	Description
Object	An object that represents the data source from which the merged data is retrieved.

Remarks

The following data sources are supported:

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

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#L105

MailMergeOptions options = productRichEdit.CreateMailMergeOptions();
options.DataSource = dataDetailedForProducts;
// Specify that the resulting table should be joined with the header table.

word-document-api-use-multiple-data-sources-for-mail-merge/CS/MailMergeSample/Default.aspx.cs#L45

    mailMergeOptions.DataSource = invoices;
}

mail-merge-in-a-richeditcontrol/CS/MailMerge/Form1.cs#L38

MailMergeOptions myMergeOptions = richEditControl1.Document.CreateMailMergeOptions();
myMergeOptions.DataSource = new SampleData();
myMergeOptions.FirstRecordIndex = 1;

word-document-api-use-docvariable-fields/CS/WordProcessingFileAPI_CalcDocumentVariable/Program.cs#L30

myMergeOptions.MergeMode = MergeMode.NewSection;
myMergeOptions.DataSource = new SampleData();

VB.NET

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

Dim options As MailMergeOptions = productRichEdit.CreateMailMergeOptions()
options.DataSource = dataDetailedForProducts
' Specify that the resulting table should be joined with the header table.

word-document-api-use-multiple-data-sources-for-mail-merge/VB/MailMergeSample/Default.aspx.vb#L39

    invoices.Add(New Invoice(2, "Invoice3", 20.0D))
    mailMergeOptions.DataSource = invoices
ElseIf Equals(templateName, "preview2") Then

mail-merge-in-a-richeditcontrol/VB/MailMerge/Form1.vb#L35

Dim myMergeOptions As MailMergeOptions = richEditControl1.Document.CreateMailMergeOptions()
myMergeOptions.DataSource = New SampleData()
myMergeOptions.FirstRecordIndex = 1

word-document-api-use-docvariable-fields/VB/WordProcessingFileAPI_CalcDocumentVariable/Program.vb#L24

myMergeOptions.MergeMode = MergeMode.NewSection
myMergeOptions.DataSource = New SampleData()