IRichEditDocumentServer.MailMerge(MailMergeOptions, String, DocumentFormat) Method
Merges the current document using the specified options and sends the result to the specified file in a specified format.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.RichEdit.v24.2.Core.dll
NuGet Package: DevExpress.RichEdit.Core
#Declaration
void MailMerge(
MailMergeOptions options,
string fileName,
DocumentFormat format
)
#Parameters
Name | Type | Description |
---|---|---|
options | Mail |
A Mail |
file |
String | A name of the file to which the merged document is saved. |
format | Document |
A Document |
#Remarks
The MailMerge method merges the current document with records, starting from the MailMergeOptions.FirstRecordIndex through the MailMergeOptions.LastRecordIndex retrieved from the MailMergeOptions.DataSource specified via the options parameter, and saves the merged document to the specified file.
The MailMerge method results in the RichEditControl.CalculateDocumentVariable event being fired for the IRichEditDocumentServer object.