RichEditDocumentServer.MailMerge(MailMergeOptions, Stream, DocumentFormat) Method
Merges the current document using the specified options and sends the result to the specified stream in a specified format.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.RichEdit.v19.2.Core.dll
Declaration
Parameters
Name | Type | Description |
---|---|---|
options | MailMergeOptions | A MailMergeOptions interface exposing options for the current merge. |
stream | Stream | A Stream object that is the output stream. |
format | DocumentFormat | A DocumentFormat enumeration member specifying the destination format. |
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 sends the merged document to the specified stream.
Note
A newer and more convenient approach to Master-Detail Mail Merge is provided by the SnapControl and SnapDocumentServer.
The MailMerge method results in the RichEditDocumentServer.CalculateDocumentVariable event being fired for the RichEditDocumentServer object.