RichEditMailMergeOptions.ViewMergedData Property

Specifies whether to display field results or field codes in a mail-merge document.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

[DefaultValue(false)]
public bool ViewMergedData { get; set; }

VB.NET

<DefaultValue(False)>
Public Property ViewMergedData As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true, to display actual data; otherwise, false.

Property Paths

You can access this nested property as listed below:

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

Remarks

Use this property to select whether the document fields should display their associated data source records or their field codes.

When the ViewMergedData is enabled, a field displays the data record with the index specified by the RichEditMailMergeOptions.ActiveRecord property.

Related GitHub Examples

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

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

    richEditControl1.LoadDocumentTemplate("weather_report.rtf");
    richEditControl1.Options.MailMerge.ViewMergedData = true;
}

how-to-export-each-record-into-a-new-pdf-file-during-the-mailmerge-operation-e4308/CS/MailMergeEachRecordSeparatePDF/Form1.cs#L21

richEditControl1.Options.MailMerge.DataSource = datasource;
richEditControl1.Options.MailMerge.ViewMergedData = true;
richEditControl1.LoadDocument("MailMergeSimple.rtf");

how-to-implement-mail-merge-in-a-richeditcontrol-e1680/CS/MailMerge/Form1.cs#L20

richEditControl1.Options.MailMerge.DataSource = new SampleData();
richEditControl1.Options.MailMerge.ViewMergedData = true;
#endregion #setdatasource

how-to-replace-document-fields-with-their-values-e3482/CS/Form1.cs#L22

    richEditControl1.Options.MailMerge.DataSource = list;
    richEditControl1.Options.MailMerge.ViewMergedData = true;
}

how-to-use-images-when-implementing-the-mail-merge-functionality-e4164/CS/Form1.cs#L20

richEditControl1.Options.MailMerge.DataSource = NorthwindDataProvider.Categories;
richEditControl1.Options.MailMerge.ViewMergedData = true;

VB.NET

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

    richEditControl1.LoadDocumentTemplate("weather_report.rtf")
    richEditControl1.Options.MailMerge.ViewMergedData = True
End Sub

how-to-export-each-record-into-a-new-pdf-file-during-the-mailmerge-operation-e4308/VB/MailMergeEachRecordSeparatePDF/Form1.vb#L23

richEditControl1.Options.MailMerge.DataSource = datasource
richEditControl1.Options.MailMerge.ViewMergedData = True
richEditControl1.LoadDocument("MailMergeSimple.rtf")

how-to-implement-mail-merge-in-a-richeditcontrol-e1680/VB/MailMerge/Form1.vb#L19

            richEditControl1.Options.MailMerge.DataSource = New SampleData()
            richEditControl1.Options.MailMerge.ViewMergedData = True
'            #End Region ' #setdatasource

how-to-replace-document-fields-with-their-values-e3482/VB/Form1.vb#L24

    richEditControl1.Options.MailMerge.DataSource = list
    richEditControl1.Options.MailMerge.ViewMergedData = True
End Sub

how-to-use-images-when-implementing-the-mail-merge-functionality-e4164/VB/Form1.vb#L22

richEditControl1.Options.MailMerge.DataSource = NorthwindDataProvider.Categories
richEditControl1.Options.MailMerge.ViewMergedData = True