Skip to main content

SpreadsheetExtension.PerformMailMerge(String, Object, String, Int32, DocumentFormat) Method

Initializes the mail merge process and generates the documents that contain the merged information.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v24.1.dll

NuGet Package: DevExpress.Web.Mvc5

Declaration

public SpreadsheetExtension PerformMailMerge(
    string pathToTemplateXlsx,
    object mailMergeDataSource,
    string mailMergeMode,
    int documentIndex,
    DocumentFormat documentFormat
)

Parameters

Name Type Description
pathToTemplateXlsx String

The path to a template for mail merge.

mailMergeDataSource Object

The data source object for mail merge.

mailMergeMode String

A string value that specifies the mail merge mode (“Worksheets”, “OneWorksheet” or “Documents”).

documentIndex Int32

The index of a document to display (when the mailMergeMode parameter is set to Documents).

documentFormat DocumentFormat

A document format in which to save a workbook (such as XLSX, XLS, etc).

Returns

Type Description
SpreadsheetExtension

The Spreadsheet extension.

See Also