MailMergeOptions Interface

Defines the mail merge options.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[ComVisible(true)]
public interface MailMergeOptions

VB.NET

<ComVisible(True)>
Public Interface MailMergeOptions

Related API Members

The following members return MailMergeOptions objects:

Library	Related API Members
WinForms Controls	RichEditControl.CreateMailMergeOptions()
WPF Controls	RichEditControl.CreateMailMergeOptions()
Office File API	Document.CreateMailMergeOptions()
	IRichEditDocumentServer.CreateMailMergeOptions()
	RichEditDocumentServer.CreateMailMergeOptions()
ASP.NET Web Forms Controls	ASPxRichEdit.CreateMailMergeOptions()
	RichEditExtension.CreateMailMergeOptions()

Related API Members

The following members return MailMergeOptions objects:

Library	Related API Members
WinForms Controls	RichEditControl.CreateMailMergeOptions()
WPF Controls	RichEditControl.CreateMailMergeOptions()
Office File API	Document.CreateMailMergeOptions()
	IRichEditDocumentServer.CreateMailMergeOptions()
	RichEditDocumentServer.CreateMailMergeOptions()
ASP.NET Web Forms Controls	ASPxRichEdit.CreateMailMergeOptions()
	RichEditExtension.CreateMailMergeOptions()

Related API Members

The following members return MailMergeOptions objects:

Library	Related API Members
WinForms Controls	RichEditControl.CreateMailMergeOptions()
WPF Controls	RichEditControl.CreateMailMergeOptions()
Office File API	Document.CreateMailMergeOptions()
	IRichEditDocumentServer.CreateMailMergeOptions()
	RichEditDocumentServer.CreateMailMergeOptions()
ASP.NET Web Forms Controls	ASPxRichEdit.CreateMailMergeOptions()
	RichEditExtension.CreateMailMergeOptions()

Remarks

To customize the mail merge options, call the Document.CreateMailMergeOptions method and pass the created MailMergeOptions instance as a parameter to the Document.MailMerge method.

The default mail merge options are specified by the RichEditMailMergeOptions class that is returned by the RichEditControlOptionsBase.MailMerge property.

For more information, refer to Mail Merge.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the MailMergeOptions interface.

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#

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

{
    MailMergeOptions myMergeOptions = richEditControl1.Document.CreateMailMergeOptions();
    myMergeOptions.MergeMode = MergeMode.NewSection;

how-to-use-document-variable-docvariable-fields-e3099/CS/DocumentVariablesExample/Form1.cs#L35

private void btnMailMerge_Click(object sender, EventArgs e) {
    MailMergeOptions myMergeOptions = richEditControl1.Document.CreateMailMergeOptions();
    myMergeOptions.MergeMode = MergeMode.NewSection;

VB.NET

how-to-implement-progress-indicator-for-slow-richeditcontrol-operations-e3075/VB/ProgressIndicator/Form1.vb#L25

Private Sub btnMailMerge_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnMailMerge.Click
    Dim myMergeOptions As MailMergeOptions = richEditControl1.Document.CreateMailMergeOptions()
    myMergeOptions.MergeMode = MergeMode.NewSection

how-to-use-document-variable-docvariable-fields-e3099/VB/DocumentVariablesExample/Form1.vb#L37

Private Sub btnMailMerge_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnMailMerge.Click
    Dim myMergeOptions As MailMergeOptions = richEditControl1.Document.CreateMailMergeOptions()
    myMergeOptions.MergeMode = MergeMode.NewSection