moveToMergeField method

moveToMergeField(fieldName)

Moves the cursor to a position just beyond the specified merge field and removes the merge field.

moveToMergeField(fieldName: string)

Parameter	Type	Description
fieldName	string	The case-insensitive name of the mail merge field.

Remarks

Note that this method deletes the merge field from the document after moving the cursor.

Returns

true if the merge field was found and the cursor was moved; false otherwise.

moveToMergeField(fieldName, isAfter, isDeleteField)

Moves the merge field to the specified merge field.

moveToMergeField(fieldName: string, isAfter: boolean, isDeleteField: boolean)

Parameter	Type	Description
fieldName	string	The case-insensitive name of the mail merge field.
isAfter	boolean	When true, moves the cursor to be after the field end. When false, moves the cursor to be before the field start.
isDeleteField	boolean	When true, deletes the merge field.

Returns

true if the merge field was found and the cursor was moved; false otherwise.

Examples

Shows how to fill MERGEFIELDs with data with a document builder instead of a mail merge.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

// Insert some MERGEFIELDS, which accept data from columns of the same name in a data source during a mail merge,
// and then fill them manually.
builder.insertField(" MERGEFIELD Chairman ");
builder.insertField(" MERGEFIELD ChiefFinancialOfficer ");
builder.insertField(" MERGEFIELD ChiefTechnologyOfficer ");

builder.moveToMergeField("Chairman");
builder.bold = true;
builder.writeln("John Doe");

builder.moveToMergeField("ChiefFinancialOfficer");
builder.italic = true;
builder.writeln("Jane Doe");

builder.moveToMergeField("ChiefTechnologyOfficer");
builder.italic = true;
builder.writeln("John Bloggs");

doc.save(base.artifactsDir + "DocumentBuilder.FillMergeFields.docx");

Shows how to insert fields, and move the document builder’s cursor to them.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);
builder.insertField("MERGEFIELD MyMergeField1 \* MERGEFORMAT");
builder.insertField("MERGEFIELD MyMergeField2 \* MERGEFORMAT");

// Move the cursor to the first MERGEFIELD.
builder.moveToMergeField("MyMergeField1", true, false);

// Note that the cursor is placed immediately after the first MERGEFIELD, and before the second.
expect(builder.currentNode).toEqual(doc.range.fields.at(1).start);
expect(builder.currentNode.previousSibling).toEqual(doc.range.fields.at(0).end);

// If we wish to edit the field's field code or contents using the builder,
// its cursor would need to be inside a field.
// To place it inside a field, we would need to call the document builder's MoveTo method
// and pass the field's start or separator node as an argument.
builder.write(" Text between our merge fields. ");

doc.save(base.artifactsDir + "DocumentBuilder.MergeFields.docx");

See Also

• module Aspose.Words
• class DocumentBuilder