public class FieldMergeSeq extends Field
To learn more, visit the Working with Fields documentation article.
Remarks:
At the moment the MERGEREC and MERGESEQ fields implement the same functionality because we don't know for sure how to skip records in Aspose.Words mail merge.
Examples:
Shows how to use MERGEREC and MERGESEQ fields to the number and count mail merge records in a mail merge's output documents.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Dear ");
FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
fieldMergeField.setFieldName("Name");
builder.writeln(",");
// A MERGEREC field will print the row number of the data being merged in every merge output document.
builder.write("\nRow number of record in data source: ");
FieldMergeRec fieldMergeRec = (FieldMergeRec) builder.insertField(FieldType.FIELD_MERGE_REC, true);
Assert.assertEquals(fieldMergeRec.getFieldCode(), " MERGEREC ");
// A MERGESEQ field will count the number of successful merges and print the current value on each respective page.
// If a mail merge skips no rows and invokes no SKIP/SKIPIF/NEXT/NEXTIF fields, then all merges are successful.
// The MERGESEQ and MERGEREC fields will display the same results of their mail merge was successful.
builder.write("\nSuccessful merge number: ");
FieldMergeSeq fieldMergeSeq = (FieldMergeSeq) builder.insertField(FieldType.FIELD_MERGE_SEQ, true);
Assert.assertEquals(fieldMergeSeq.getFieldCode(), " MERGESEQ ");
// Insert a SKIPIF field, which will skip a merge if the name is "John Doe".
FieldSkipIf fieldSkipIf = (FieldSkipIf) builder.insertField(FieldType.FIELD_SKIP_IF, true);
builder.moveTo(fieldSkipIf.getSeparator());
fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
fieldMergeField.setFieldName("Name");
fieldSkipIf.setLeftExpression("=");
fieldSkipIf.setRightExpression("John Doe");
// Create a data source with 3 rows, one of them having "John Doe" as a value for the "Name" column.
// Since a SKIPIF field will be triggered once by that value, the output of our mail merge will have 2 pages instead of 3.
// On page 1, the MERGESEQ and MERGEREC fields will both display "1".
// On page 2, the MERGEREC field will display "3" and the MERGESEQ field will display "2".
DataTable table = new DataTable("Employees");
table.getColumns().add("Name");
table.getRows().add("Jane Doe");
table.getRows().add("John Doe");
table.getRows().add("Joe Bloggs");
doc.getMailMerge().execute(table);
doc.save(getArtifactsDir() + "Field.MERGEREC.MERGESEQ.docx");
getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, update