GetMailMergeData
Returns the mail merge data.
Syntax
expression.GetMailMergeData(nSheet, bWithFormat);
expression - A variable that represents a Api class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| nSheet | Required | number | The sheet index. | |
| bWithFormat | Optional | boolean | false | Specifies that the data will be received with the format. |
Returns
string[][]
Example
This example shows how to get the mail merge data.
- Code
- Result
let worksheet = Api.GetActiveSheet();
worksheet.SetColumnWidth(0, 20);
worksheet.GetRange("A1").SetValue("Email address");
worksheet.GetRange("B1").SetValue("Greeting");
worksheet.GetRange("C1").SetValue("First name");
worksheet.GetRange("D1").SetValue("Last name");
worksheet.GetRange("A2").SetValue("user1@example.com");
worksheet.GetRange("B2").SetValue("Dear");
worksheet.GetRange("C2").SetValue("John");
worksheet.GetRange("D2").SetValue("Smith");
worksheet.GetRange("A3").SetValue("user2@example.com");
worksheet.GetRange("B3").SetValue("Hello");
worksheet.GetRange("C3").SetValue("Kate");
worksheet.GetRange("D3").SetValue("Cage");
let mailMergeData = Api.GetMailMergeData(0);
worksheet.GetRange("A5").SetValue("Mail merge data: " + mailMergeData);