Skip to main content

WrapInMailMergeField

Wraps a run in a mail merge field.

Syntax

expression.WrapInMailMergeField();

expression - A variable that represents a ApiRun class.

Parameters

This method doesn't have any parameters.

Returns

boolean

Example

This example wraps a run in a mail merge field.

// How to create a run wrapped in 'Mail Merge Field'.

// Add a text run to the mail merge field.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let run = Api.CreateRun();
run.AddText("Name");
paragraph.AddElement(run);
run.WrapInMailMergeField();
paragraph.AddLineBreak();
run = Api.CreateRun();
run.AddText("Surname");
paragraph.AddElement(run);
run.WrapInMailMergeField();