TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

LoadMailMergeData

LoadMailMergeData(aList) → { boolean }

Loads data for the mail merge.

Parameters:

Name Type Description
aList Array.<Array.<String>>

Mail merge data. The first element of the array is the array with names of the merge fields. The rest of the array elements are arrays with values for the merge fields.

Returns:

Type
boolean

Example

Copy code
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var arrField = ["Greeting line", "First name", "Last name"];
for (let i = 0; i < 3; i++) {
    var oRun = Api.CreateRun();
    oRun.AddText(arrField[i]);
    oParagraph.AddElement(oRun);
    oRun.WrapInMailMergeField();
    oParagraph.AddText(" ");
}
oParagraph.AddText("!");
Api.LoadMailMergeData([arrField, ["Dear", "John", "Smith"], ["Hello", "Lara", "Davis"]]);
Api.MailMerge();
builder.SaveFile("docx", "LoadMailMergeData.docx");
builder.CloseFile();

Resulting document