IRichEditDocumentServer.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.v24.2.Core.dll
NuGet Package: DevExpress.RichEdit.Core
#Declaration
void MailMerge(
MailMergeOptions options,
Stream stream,
DocumentFormat format
)
#Parameters
Name | Type | Description |
---|---|---|
options | Mail |
A Mail |
stream | Stream | A Stream object that is the output stream. |
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 sends the merged document to the specified stream.
The MailMerge method results in the RichEditControl.CalculateDocumentVariable event being fired for the IRichEditDocumentServer object.