RichEditMailMergeOptions.DataSource Property

Specifies the data source of a mail-merge document.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.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*	A Object value, specifying the document data source.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to DataSource
WinForms Controls	SnapControlOptions	.MailMerge .DataSource
	RichEditControlOptions	.MailMerge .DataSource
WPF Controls	RichEditControlOptions	.MailMerge .DataSource
Office File API	RichEditControlOptionsBase	.MailMerge .DataSource

Remarks

A mail-merge data source can be any object implementing the IList interface.

When connecting to a data source that contains multiple data tables, specify the required data member by using the RichEditMailMergeOptions.DataMember property.

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;

utility-for-creating-a-mail-merge-template-e3661/CS/Form1.cs#L60

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

master-detail-mail-merge-essential-the-simplest-implementation-e3662/CS/Form1.cs#L20

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

expandoobjects-data-binding-and-mail-merge-in-xtrarichedit-e3752/CS/ExpandoObject_MailMerge/Form1.cs#L24

dynamic weathers = GetExpandoFromXml("weather.xml");
richEditControl1.Options.MailMerge.DataSource = weathers;

how-to-implement-progress-indicator-for-slow-richeditcontrol-operations-e3075/CS/ProgressIndicator/Form1.cs#L22

    richEditControl1.LoadDocument("Docs\\invitation.docx");
    richEditControl1.Options.MailMerge.DataSource = new SampleData();
}

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")

utility-for-creating-a-mail-merge-template-e3661/VB/Form1.vb#L62

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

master-detail-mail-merge-essential-the-simplest-implementation-e3662/VB/Form1.vb#L22

Private Sub performMailMergeItem_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs) Handles performMailMergeItem.ItemClick
    richEditCategoryTemplate.Options.MailMerge.DataSource = NorthwindDataProvider.Categories

how-to-create-a-master-detail-report-in-a-richeditcontrol-e3331/VB/RichEditMasterDetailMailMerge/Form1.vb#L58

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

expandoobjects-data-binding-and-mail-merge-in-xtrarichedit-e3752/VB/ExpandoObject_MailMerge/Form1.vb#L23

Dim weathers As Object = GetExpandoFromXml("weather.xml")
richEditControl1.Options.MailMerge.DataSource = weathers