Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Collapse]ASP.NET Controls and MVC Extensions
 [Expand]Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]ASP.NET WebForms Controls
 [Expand]ASP.NET MVC Extensions
 [Expand]Localization
 [Expand]Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Data.Linq
  [Expand]DevExpress.Web
  [Expand]DevExpress.Web.ASPxGauges
  [Expand]DevExpress.Web.ASPxGauges.Base
  [Expand]DevExpress.Web.ASPxGauges.Scripts
  [Expand]DevExpress.Web.ASPxHtmlEditor
  [Expand]DevExpress.Web.ASPxHtmlEditor.Localization
  [Expand]DevExpress.Web.ASPxHtmlEditor.Scripts
  [Expand]DevExpress.Web.ASPxPivotGrid
  [Expand]DevExpress.Web.ASPxPivotGrid.Data
  [Expand]DevExpress.Web.ASPxPivotGrid.HtmlControls
  [Expand]DevExpress.Web.ASPxPivotGrid.Scripts
  [Collapse]DevExpress.Web.ASPxRichEdit
   [Collapse]ASPxRichEdit Class
     ASPxRichEdit Members
     ASPxRichEdit Constructor
    [Expand]ASPxRichEdit Properties
    [Expand]ASPxRichEdit Events
    [Collapse]ASPxRichEdit Methods
      AddImageToCache Method
      CreateDefaultRibbonTabs Method
      CreateMailMergeOptions Method
     [Expand]ExportToPdf Method
      GetWorkDirectory Method
      IsInternalServiceCallback Method
     [Collapse]MailMerge Method
       MailMerge(Document) Method
       MailMerge(MailMergeOptions, Document) Method
       MailMerge(String, DocumentFormat) Method
       MailMerge(Stream, DocumentFormat) Method
       MailMerge(MailMergeOptions, String, DocumentFormat) Method
       MailMerge(MailMergeOptions, Stream, DocumentFormat) Method
      New Method
     [Expand]Open Method
      RaiseDocumentSelectorCloudProviderRequest Method
      RaiseDocumentSelectorFileUploading Method
      RaiseDocumentSelectorFolderCreating Method
      RaiseDocumentSelectorItemCopying Method
      RaiseDocumentSelectorItemDeleting Method
      RaiseDocumentSelectorItemMoving Method
      RaiseDocumentSelectorItemRenaming Method
      Save Method
     [Expand]SaveCopy Method
   [Expand]ASPxRichEditAuthenticationSettings Class
   [Expand]ASPxRichEditAutoCorrectReplaceInfo Class
   [Expand]ASPxRichEditAutoCorrectReplaceInfoCollection Class
   [Expand]ASPxRichEditAutoCorrectReplaceInfoCollectionSettings Class
   [Expand]ASPxRichEditAutoCorrectSettings Class
   [Expand]ASPxRichEditBehaviorSettings Class
   [Expand]ASPxRichEditBookmarkSettings Class
   [Expand]ASPxRichEditCharacterFormattingDetailedSettings Class
   [Expand]ASPxRichEditDocumentCapabilitiesSettings Class
   [Expand]ASPxRichEditHorizontalRulerSettings Class
   [Expand]ASPxRichEditNumberingSettings Class
   [Expand]ASPxRichEditOptionsSpelling Class
   [Expand]ASPxRichEditRangePermissionSettings Class
   [Expand]ASPxRichEditSettings Class
   [Expand]ASPxRichEditSettingsBase Class
   [Expand]ASPxRichEditSpellCheckerSettings Class
   [Expand]RichEditClientSideEvents Class
   [Expand]RichEditDialogSettings Class
   [Expand]RichEditDocumentSelectorCommonSettings Class
   [Expand]RichEditDocumentSelectorSettings Class
   [Expand]RichEditDocumentSelectorUploadSettings Class
   [Expand]RichEditFileManager Class
   [Expand]RichEditFileManagerCommonSettings Class
   [Expand]RichEditFileManagerEditingSettings Class
   [Expand]RichEditFileManagerFoldersSettings Class
   [Expand]RichEditFileManagerStyles Class
   [Expand]RichEditFileManagerValidationSettings Class
   [Expand]RichEditFolderManager Class
   [Expand]RichEditImages Class
   [Expand]RichEditInsertLinkDialogSettings Class
   [Expand]RichEditInsertPictureDialogSettings Class
   [Expand]RichEditPopupMenuItem Class
   [Expand]RichEditPopupMenuItemCollection Class
   [Expand]RichEditRibbonContextTabCategoryCollection Class
    RichEditRibbonMode Enumeration
   [Expand]RichEditRibbonTabCollection Class
   [Expand]RichEditRulerImages Class
   [Expand]RichEditSaveFileDialogSettings Class
    RichEditUnit Enumeration
    SaveFileDialogDisplaySectionMode Enumeration
  [Expand]DevExpress.Web.ASPxRichEdit.Localization
  [Expand]DevExpress.Web.ASPxRichEdit.Scripts
  [Expand]DevExpress.Web.ASPxScheduler
  [Expand]DevExpress.Web.ASPxScheduler.Commands
  [Expand]DevExpress.Web.ASPxScheduler.Commands.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Controls
  [Expand]DevExpress.Web.ASPxScheduler.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Drawing
  [Expand]DevExpress.Web.ASPxScheduler.Localization
  [Expand]DevExpress.Web.ASPxScheduler.Reporting
  [Expand]DevExpress.Web.ASPxScheduler.Scripts
  [Expand]DevExpress.Web.ASPxSpellChecker
  [Expand]DevExpress.Web.ASPxSpellChecker.Localization
  [Expand]DevExpress.Web.ASPxSpellChecker.Scripts
  [Expand]DevExpress.Web.ASPxSpreadsheet
  [Expand]DevExpress.Web.ASPxSpreadsheet.Localization
  [Expand]DevExpress.Web.ASPxSpreadsheet.Scripts
  [Expand]DevExpress.Web.ASPxTreeList
  [Expand]DevExpress.Web.ASPxTreeList.Internal
  [Expand]DevExpress.Web.ASPxTreeList.Localization
  [Expand]DevExpress.Web.ASPxTreeList.Scripts
  [Expand]DevExpress.Web.Captcha
  [Expand]DevExpress.Web.Data
  [Expand]DevExpress.Web.Internal
  [Expand]DevExpress.Web.Localization
  [Expand]DevExpress.Web.Mvc
  [Expand]DevExpress.Web.Mvc.BinderSettings
  [Expand]DevExpress.Web.Mvc.Controllers
  [Expand]DevExpress.Web.MVC.Scripts
  [Expand]DevExpress.Web.Mvc.UI
  [Expand]DevExpress.Web.Office
  [Expand]DevExpress.Web.Office.Internal
  [Expand]DevExpress.Web.Rendering
  [Expand]DevExpress.Web.Scripts
  [Expand]DevExpress.XtraCharts.Web
  [Expand]DevExpress.XtraCharts.Web.Designer
  [Expand]DevExpress.XtraCharts.Web.Scripts
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

ASPxRichEdit.MailMerge(MailMergeOptions, Stream, DocumentFormat) Method

Initializes the mail merge process and generates the resulting documents containing the merged information.

Namespace:DevExpress.Web.ASPxRichEdit
Assembly:DevExpress.Web.ASPxRichEdit.v18.1.dll

Expanded Syntax

Parameters

mailMergeOptions
Type: MailMergeOptions
A DevExpress.XtraRichEdit.API.Native.MailMergeOptions interface exposing options for the current merge.
stream
Type: Stream
A System.IO.Stream object that is the output stream.
documentFormat
Type: DocumentFormat
A DevExpress.XtraRichEdit.DocumentFormat enumeration member specifying the destination format.

Expanded Remarks

The MailMerge method merges the current document with records retrieved from the default mail merge data source specified via the RichEdit's DataSourceID (or DataSource) property (starting from the DevExpress.XtraRichEdit.API.Native.MailMergeOptions.FirstRecordIndex through the DevExpress.XtraRichEdit.API.Native.MailMergeOptions.LastRecordIndex, as specified via the mailMergeOptions parameter) and sends the merged document to the specified stream.

Expanded See Also

Is this topic helpful?​​​​​​​