FieldSkipIf

Inheritance: java.lang.Object, com.aspose.words.Field

public class FieldSkipIf extends Field

Implements the SKIPIF field.

To learn more, visit the Working with Fields documentation article.

Remarks:

Compares the values designated by the expressions getLeftExpression() / setLeftExpression(java.lang.String) and getRightExpression() / setRightExpression(java.lang.String) in comparison using the operator designated by getComparisonOperator() / setComparisonOperator(java.lang.String). If the comparison is true, SKIPIF cancels the current merge document, moves to the next data record in the data source, and starts a new merge document. If the comparison is false, the current merge document is continued.

Examples:

Shows how to skip pages in a mail merge using the SKIPIF field.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert a SKIPIF field. If the current row of a mail merge operation fulfills the condition
 // which the expressions of this field state, then the mail merge operation aborts the current row,
 // discards the current merge document, and then immediately moves to the next row to begin the next merge document.
 FieldSkipIf fieldSkipIf = (FieldSkipIf) builder.insertField(FieldType.FIELD_SKIP_IF, true);

 // Move the builder to the SKIPIF field's separator so we can place a MERGEFIELD inside the SKIPIF field.
 builder.moveTo(fieldSkipIf.getSeparator());
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Department");

 // The MERGEFIELD refers to the "Department" column in our data table. If a row from that table
 // has a value of "HR" in its "Department" column, then this row will fulfill the condition.
 fieldSkipIf.setLeftExpression("=");
 fieldSkipIf.setRightExpression("HR");

 // Add content to our document, create the data source, and execute the mail merge.
 builder.moveToDocumentEnd();
 builder.write("Dear ");
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Name");
 builder.writeln(", ");

 // This table has three rows, and one of them fulfills the condition of our SKIPIF field.
 // The mail merge will produce two pages.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Name");
 table.getColumns().add("Department");
 table.getRows().add("John Doe", "Sales");
 table.getRows().add("Jane Doe", "Accounting");
 table.getRows().add("John Cardholder", "HR");

 doc.getMailMerge().execute(table);
 doc.save(getArtifactsDir() + "Field.SKIPIF.docx");

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");

Methods

MethodDescription
getComparisonOperator()Gets the comparison operator.
getDisplayResult()Gets the text that represents the displayed field result.
getEnd()Gets the node that represents the field end.
getFieldCode()Returns text between field start and field separator (or field end if there is no separator).
getFieldCode(boolean includeChildFieldCodes)Returns text between field start and field separator (or field end if there is no separator).
getFormat()Gets a FieldFormat object that provides typed access to field’s formatting.
getLeftExpression()Gets the left part of the comparison expression.
getLocaleId()Gets the LCID of the field.
getResult()Gets text that is between the field separator and field end.
getRightExpression()Gets the right part of the comparison expression.
getSeparator()Gets the node that represents the field separator.
getStart()Gets the node that represents the start of the field.
getType()Gets the Microsoft Word field type.
isDirty()Gets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
isDirty(boolean value)Sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
isLocked()Gets whether the field is locked (should not recalculate its result).
isLocked(boolean value)Sets whether the field is locked (should not recalculate its result).
remove()Removes the field from the document.
setComparisonOperator(String value)Sets the comparison operator.
setLeftExpression(String value)Sets the left part of the comparison expression.
setLocaleId(int value)Sets the LCID of the field.
setResult(String value)Sets text that is between the field separator and field end.
setRightExpression(String value)Sets the right part of the comparison expression.
unlink()Performs the field unlink.
update()Performs the field update.
update(boolean ignoreMergeFormat)Performs a field update.

getComparisonOperator()

public String getComparisonOperator()

Gets the comparison operator.

Examples:

Shows how to skip pages in a mail merge using the SKIPIF field.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert a SKIPIF field. If the current row of a mail merge operation fulfills the condition
 // which the expressions of this field state, then the mail merge operation aborts the current row,
 // discards the current merge document, and then immediately moves to the next row to begin the next merge document.
 FieldSkipIf fieldSkipIf = (FieldSkipIf) builder.insertField(FieldType.FIELD_SKIP_IF, true);

 // Move the builder to the SKIPIF field's separator so we can place a MERGEFIELD inside the SKIPIF field.
 builder.moveTo(fieldSkipIf.getSeparator());
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Department");

 // The MERGEFIELD refers to the "Department" column in our data table. If a row from that table
 // has a value of "HR" in its "Department" column, then this row will fulfill the condition.
 fieldSkipIf.setLeftExpression("=");
 fieldSkipIf.setRightExpression("HR");

 // Add content to our document, create the data source, and execute the mail merge.
 builder.moveToDocumentEnd();
 builder.write("Dear ");
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Name");
 builder.writeln(", ");

 // This table has three rows, and one of them fulfills the condition of our SKIPIF field.
 // The mail merge will produce two pages.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Name");
 table.getColumns().add("Department");
 table.getRows().add("John Doe", "Sales");
 table.getRows().add("Jane Doe", "Accounting");
 table.getRows().add("John Cardholder", "HR");

 doc.getMailMerge().execute(table);
 doc.save(getArtifactsDir() + "Field.SKIPIF.docx");

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");

Returns: java.lang.String - The comparison operator.

getDisplayResult()

public String getDisplayResult()

Gets the text that represents the displayed field result.

Remarks:

The Document.updateListLabels() method must be called to obtain correct value for the FieldListNum, FieldAutoNum, FieldAutoNumOut and FieldAutoNumLgl fields.

Examples:

Shows how to get the real text that a field displays in the document.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.write("This document was written by ");
 FieldAuthor fieldAuthor = (FieldAuthor) builder.insertField(FieldType.FIELD_AUTHOR, true);
 fieldAuthor.setAuthorName("John Doe");

 // We can use the DisplayResult property to verify what exact text
 // a field would display in its place in the document.
 Assert.assertEquals("", fieldAuthor.getDisplayResult());

 // Fields do not maintain accurate result values in real-time.
 // To make sure our fields display accurate results at any given time,
 // such as right before a save operation, we need to update them manually.
 fieldAuthor.update();

 Assert.assertEquals("John Doe", fieldAuthor.getDisplayResult());

 doc.save(getArtifactsDir() + "Field.DisplayResult.docx");

Returns: java.lang.String - The text that represents the displayed field result.

getEnd()

public FieldEnd getEnd()

Gets the node that represents the field end.

Examples:

Shows how to work with a collection of fields.


 public void fieldCollection() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
     builder.insertField(" TIME ");
     builder.insertField(" REVNUM ");
     builder.insertField(" AUTHOR  \"John Doe\" ");
     builder.insertField(" SUBJECT \"My Subject\" ");
     builder.insertField(" QUOTE \"Hello world!\" ");
     doc.updateFields();

     FieldCollection fields = doc.getRange().getFields();

     Assert.assertEquals(6, fields.getCount());

     // Iterate over the field collection, and print contents and type
     // of every field using a custom visitor implementation.
     FieldVisitor fieldVisitor = new FieldVisitor();

     Iterator fieldEnumerator = fields.iterator();

     while (fieldEnumerator.hasNext()) {
         if (fieldEnumerator != null) {
             Field currentField = fieldEnumerator.next();

             currentField.getStart().accept(fieldVisitor);
             if (currentField.getSeparator() != null) {
                 currentField.getSeparator().accept(fieldVisitor);
             }
             currentField.getEnd().accept(fieldVisitor);
         } else {
             System.out.println("There are no fields in the document.");
         }
     }

     System.out.println(fieldVisitor.getText());
 }

 /// 
 /// Document visitor implementation that prints field info.
 /// 
 public static class FieldVisitor extends DocumentVisitor {
     public FieldVisitor() {
         mBuilder = new StringBuilder();
     }

     /// 
     /// Gets the plain text of the document that was accumulated by the visitor.
     /// 
     public String getText() {
         return mBuilder.toString();
     }

     /// 
     /// Called when a FieldStart node is encountered in the document.
     /// 
     public int visitFieldStart(final FieldStart fieldStart) {
         mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n");
         mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n");
         mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n");

         return VisitorAction.CONTINUE;
     }

     /// 
     /// Called when a FieldSeparator node is encountered in the document.
     /// 
     public int visitFieldSeparator(final FieldSeparator fieldSeparator) {
         mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n");

         return VisitorAction.CONTINUE;
     }

     /// 
     /// Called when a FieldEnd node is encountered in the document.
     /// 
     public int visitFieldEnd(final FieldEnd fieldEnd) {
         mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n");

         return VisitorAction.CONTINUE;
     }

     private final  StringBuilder mBuilder;
 }

Returns: FieldEnd - The node that represents the field end.

getFieldCode()

public String getFieldCode()

Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.

Examples:

Shows how to insert a field into a document using a field code.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

 Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());
 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());

Shows how to get a field’s field code.


 // Open a document which contains a MERGEFIELD inside an IF field.
 Document doc = new Document(getMyDir() + "Nested fields.docx");
 FieldIf fieldIf = (FieldIf) doc.getRange().getFields().get(0);

 // There are two ways of getting a field's field code:
 // 1 -  Omit its inner fields:
 Assert.assertEquals(" IF  > 0 \" (surplus of ) \" \"\" ", fieldIf.getFieldCode(false));

 // 2 -  Include its inner fields:
 Assert.assertEquals(" IF  MERGEFIELD NetIncome  > 0 \" (surplus of  MERGEFIELD  NetIncome \\f $ ) \" \"\" ",
         fieldIf.getFieldCode(true));

 // By default, the GetFieldCode method displays inner fields.
 Assert.assertEquals(fieldIf.getFieldCode(), fieldIf.getFieldCode(true));

Returns: java.lang.String

getFieldCode(boolean includeChildFieldCodes)

public String getFieldCode(boolean includeChildFieldCodes)

Returns text between field start and field separator (or field end if there is no separator).

Examples:

Shows how to get a field’s field code.


 // Open a document which contains a MERGEFIELD inside an IF field.
 Document doc = new Document(getMyDir() + "Nested fields.docx");
 FieldIf fieldIf = (FieldIf) doc.getRange().getFields().get(0);

 // There are two ways of getting a field's field code:
 // 1 -  Omit its inner fields:
 Assert.assertEquals(" IF  > 0 \" (surplus of ) \" \"\" ", fieldIf.getFieldCode(false));

 // 2 -  Include its inner fields:
 Assert.assertEquals(" IF  MERGEFIELD NetIncome  > 0 \" (surplus of  MERGEFIELD  NetIncome \\f $ ) \" \"\" ",
         fieldIf.getFieldCode(true));

 // By default, the GetFieldCode method displays inner fields.
 Assert.assertEquals(fieldIf.getFieldCode(), fieldIf.getFieldCode(true));

Parameters:

ParameterTypeDescription
includeChildFieldCodesbooleantrue if child field codes should be included.

Returns: java.lang.String

getFormat()

public FieldFormat getFormat()

Gets a FieldFormat object that provides typed access to field’s formatting.

Examples:

Shows how to format field results.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Use a document builder to insert a field that displays a result with no format applied.
 Field field = builder.insertField("= 2 + 3");

 Assert.assertEquals("= 2 + 3", field.getFieldCode());
 Assert.assertEquals("5", field.getResult());

 // We can apply a format to a field's result using the field's properties.
 // Below are three types of formats that we can apply to a field's result.
 // 1 -  Numeric format:
 FieldFormat format = field.getFormat();
 format.setNumericFormat("$###.00");
 field.update();

 Assert.assertEquals("= 2 + 3 \\# $###.00", field.getFieldCode());
 Assert.assertEquals("$  5.00", field.getResult());

 // 2 -  Date/time format:
 field = builder.insertField("DATE");
 format = field.getFormat();
 format.setDateTimeFormat("dddd, MMMM dd, yyyy");
 field.update();

 Assert.assertEquals("DATE \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode());
 System.out.println("Today's date, in {format.DateTimeFormat} format:\n\t{field.Result}");

 // 3 -  General format:
 field = builder.insertField("= 25 + 33");
 format = field.getFormat();
 format.getGeneralFormats().add(GeneralFormat.LOWERCASE_ROMAN);
 format.getGeneralFormats().add(GeneralFormat.UPPER);
 field.update();

 int index = 0;
 Iterator generalFormatEnumerator = format.getGeneralFormats().iterator();
 while (generalFormatEnumerator.hasNext()) {
     int value = generalFormatEnumerator.next();
     System.out.println(MessageFormat.format("General format index {0}: {1}", index++, value));
 }

 Assert.assertEquals("= 25 + 33 \\* roman \\* Upper", field.getFieldCode());
 Assert.assertEquals("LVIII", field.getResult());
 Assert.assertEquals(2, format.getGeneralFormats().getCount());
 Assert.assertEquals(GeneralFormat.LOWERCASE_ROMAN, format.getGeneralFormats().get(0));

 // We can remove our formats to revert the field's result to its original form.
 format.getGeneralFormats().remove(GeneralFormat.LOWERCASE_ROMAN);
 format.getGeneralFormats().removeAt(0);
 Assert.assertEquals(0, format.getGeneralFormats().getCount());
 field.update();

 Assert.assertEquals("= 25 + 33  ", field.getFieldCode());
 Assert.assertEquals("58", field.getResult());
 Assert.assertEquals(0, format.getGeneralFormats().getCount());

Returns: FieldFormat - A FieldFormat object that provides typed access to field’s formatting.

getLeftExpression()

public String getLeftExpression()

Gets the left part of the comparison expression.

Examples:

Shows how to skip pages in a mail merge using the SKIPIF field.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert a SKIPIF field. If the current row of a mail merge operation fulfills the condition
 // which the expressions of this field state, then the mail merge operation aborts the current row,
 // discards the current merge document, and then immediately moves to the next row to begin the next merge document.
 FieldSkipIf fieldSkipIf = (FieldSkipIf) builder.insertField(FieldType.FIELD_SKIP_IF, true);

 // Move the builder to the SKIPIF field's separator so we can place a MERGEFIELD inside the SKIPIF field.
 builder.moveTo(fieldSkipIf.getSeparator());
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Department");

 // The MERGEFIELD refers to the "Department" column in our data table. If a row from that table
 // has a value of "HR" in its "Department" column, then this row will fulfill the condition.
 fieldSkipIf.setLeftExpression("=");
 fieldSkipIf.setRightExpression("HR");

 // Add content to our document, create the data source, and execute the mail merge.
 builder.moveToDocumentEnd();
 builder.write("Dear ");
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Name");
 builder.writeln(", ");

 // This table has three rows, and one of them fulfills the condition of our SKIPIF field.
 // The mail merge will produce two pages.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Name");
 table.getColumns().add("Department");
 table.getRows().add("John Doe", "Sales");
 table.getRows().add("Jane Doe", "Accounting");
 table.getRows().add("John Cardholder", "HR");

 doc.getMailMerge().execute(table);
 doc.save(getArtifactsDir() + "Field.SKIPIF.docx");

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");

Returns: java.lang.String - The left part of the comparison expression.

getLocaleId()

public int getLocaleId()

Gets the LCID of the field.

Examples:

Shows how to insert a field and work with its locale.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert a DATE field, and then print the date it will display.
 // Your thread's current culture determines the formatting of the date.
 Field field = builder.insertField("DATE");
 System.out.println(MessageFormat.format("Today''s date, as displayed in the \"{0}\" culture: {1}", Locale.getDefault().getDisplayLanguage(), field.getResult()));

 Assert.assertEquals(1033, field.getLocaleId());
 // Changing the culture of our thread will impact the result of the DATE field.
 // Another way to get the DATE field to display a date in a different culture is to use its LocaleId property.
 // This way allows us to avoid changing the thread's culture to get this effect.
 doc.getFieldOptions().setFieldUpdateCultureSource(FieldUpdateCultureSource.FIELD_CODE);
 CultureInfo de = new CultureInfo("de-DE");
 field.setLocaleId(1031);
 field.update();

 System.out.println(MessageFormat.format("Today''s date, as displayed according to the \"{0}\" culture: {1}", Locale.forLanguageTag(LocaleUtil.getLocaleFromLCID(field.getLocaleId())).getDisplayLanguage(), field.getResult()));

Returns: int - The LCID of the field.

getResult()

public String getResult()

Gets text that is between the field separator and field end.

Examples:

Shows how to insert a field into a document using a field code.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

 Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());
 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());

Returns: java.lang.String - Text that is between the field separator and field end.

getRightExpression()

public String getRightExpression()

Gets the right part of the comparison expression.

Examples:

Shows how to skip pages in a mail merge using the SKIPIF field.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert a SKIPIF field. If the current row of a mail merge operation fulfills the condition
 // which the expressions of this field state, then the mail merge operation aborts the current row,
 // discards the current merge document, and then immediately moves to the next row to begin the next merge document.
 FieldSkipIf fieldSkipIf = (FieldSkipIf) builder.insertField(FieldType.FIELD_SKIP_IF, true);

 // Move the builder to the SKIPIF field's separator so we can place a MERGEFIELD inside the SKIPIF field.
 builder.moveTo(fieldSkipIf.getSeparator());
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Department");

 // The MERGEFIELD refers to the "Department" column in our data table. If a row from that table
 // has a value of "HR" in its "Department" column, then this row will fulfill the condition.
 fieldSkipIf.setLeftExpression("=");
 fieldSkipIf.setRightExpression("HR");

 // Add content to our document, create the data source, and execute the mail merge.
 builder.moveToDocumentEnd();
 builder.write("Dear ");
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Name");
 builder.writeln(", ");

 // This table has three rows, and one of them fulfills the condition of our SKIPIF field.
 // The mail merge will produce two pages.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Name");
 table.getColumns().add("Department");
 table.getRows().add("John Doe", "Sales");
 table.getRows().add("Jane Doe", "Accounting");
 table.getRows().add("John Cardholder", "HR");

 doc.getMailMerge().execute(table);
 doc.save(getArtifactsDir() + "Field.SKIPIF.docx");

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");

Returns: java.lang.String - The right part of the comparison expression.

getSeparator()

public FieldSeparator getSeparator()

Gets the node that represents the field separator. Can be null .

Examples:

Shows how to work with a collection of fields.


 public void fieldCollection() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
     builder.insertField(" TIME ");
     builder.insertField(" REVNUM ");
     builder.insertField(" AUTHOR  \"John Doe\" ");
     builder.insertField(" SUBJECT \"My Subject\" ");
     builder.insertField(" QUOTE \"Hello world!\" ");
     doc.updateFields();

     FieldCollection fields = doc.getRange().getFields();

     Assert.assertEquals(6, fields.getCount());

     // Iterate over the field collection, and print contents and type
     // of every field using a custom visitor implementation.
     FieldVisitor fieldVisitor = new FieldVisitor();

     Iterator fieldEnumerator = fields.iterator();

     while (fieldEnumerator.hasNext()) {
         if (fieldEnumerator != null) {
             Field currentField = fieldEnumerator.next();

             currentField.getStart().accept(fieldVisitor);
             if (currentField.getSeparator() != null) {
                 currentField.getSeparator().accept(fieldVisitor);
             }
             currentField.getEnd().accept(fieldVisitor);
         } else {
             System.out.println("There are no fields in the document.");
         }
     }

     System.out.println(fieldVisitor.getText());
 }

 /// 
 /// Document visitor implementation that prints field info.
 /// 
 public static class FieldVisitor extends DocumentVisitor {
     public FieldVisitor() {
         mBuilder = new StringBuilder();
     }

     /// 
     /// Gets the plain text of the document that was accumulated by the visitor.
     /// 
     public String getText() {
         return mBuilder.toString();
     }

     /// 
     /// Called when a FieldStart node is encountered in the document.
     /// 
     public int visitFieldStart(final FieldStart fieldStart) {
         mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n");
         mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n");
         mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n");

         return VisitorAction.CONTINUE;
     }

     /// 
     /// Called when a FieldSeparator node is encountered in the document.
     /// 
     public int visitFieldSeparator(final FieldSeparator fieldSeparator) {
         mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n");

         return VisitorAction.CONTINUE;
     }

     /// 
     /// Called when a FieldEnd node is encountered in the document.
     /// 
     public int visitFieldEnd(final FieldEnd fieldEnd) {
         mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n");

         return VisitorAction.CONTINUE;
     }

     private final  StringBuilder mBuilder;
 }

Returns: FieldSeparator - The node that represents the field separator.

getStart()

public FieldStart getStart()

Gets the node that represents the start of the field.

Examples:

Shows how to work with a collection of fields.


 public void fieldCollection() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
     builder.insertField(" TIME ");
     builder.insertField(" REVNUM ");
     builder.insertField(" AUTHOR  \"John Doe\" ");
     builder.insertField(" SUBJECT \"My Subject\" ");
     builder.insertField(" QUOTE \"Hello world!\" ");
     doc.updateFields();

     FieldCollection fields = doc.getRange().getFields();

     Assert.assertEquals(6, fields.getCount());

     // Iterate over the field collection, and print contents and type
     // of every field using a custom visitor implementation.
     FieldVisitor fieldVisitor = new FieldVisitor();

     Iterator fieldEnumerator = fields.iterator();

     while (fieldEnumerator.hasNext()) {
         if (fieldEnumerator != null) {
             Field currentField = fieldEnumerator.next();

             currentField.getStart().accept(fieldVisitor);
             if (currentField.getSeparator() != null) {
                 currentField.getSeparator().accept(fieldVisitor);
             }
             currentField.getEnd().accept(fieldVisitor);
         } else {
             System.out.println("There are no fields in the document.");
         }
     }

     System.out.println(fieldVisitor.getText());
 }

 /// 
 /// Document visitor implementation that prints field info.
 /// 
 public static class FieldVisitor extends DocumentVisitor {
     public FieldVisitor() {
         mBuilder = new StringBuilder();
     }

     /// 
     /// Gets the plain text of the document that was accumulated by the visitor.
     /// 
     public String getText() {
         return mBuilder.toString();
     }

     /// 
     /// Called when a FieldStart node is encountered in the document.
     /// 
     public int visitFieldStart(final FieldStart fieldStart) {
         mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n");
         mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n");
         mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n");

         return VisitorAction.CONTINUE;
     }

     /// 
     /// Called when a FieldSeparator node is encountered in the document.
     /// 
     public int visitFieldSeparator(final FieldSeparator fieldSeparator) {
         mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n");

         return VisitorAction.CONTINUE;
     }

     /// 
     /// Called when a FieldEnd node is encountered in the document.
     /// 
     public int visitFieldEnd(final FieldEnd fieldEnd) {
         mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n");

         return VisitorAction.CONTINUE;
     }

     private final  StringBuilder mBuilder;
 }

Returns: FieldStart - The node that represents the start of the field.

getType()

public int getType()

Gets the Microsoft Word field type.

Examples:

Shows how to insert a field into a document using a field code.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

 Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());
 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());

Returns: int - The Microsoft Word field type. The returned value is one of FieldType constants.

isDirty()

public boolean isDirty()

Gets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.

Examples:

Shows how to use special property for updating field result.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Give the document's built-in "Author" property value, and then display it with a field.
 doc.getBuiltInDocumentProperties().setAuthor("John Doe");
 FieldAuthor field = (FieldAuthor) builder.insertField(FieldType.FIELD_AUTHOR, true);

 Assert.assertFalse(field.isDirty());
 Assert.assertEquals("John Doe", field.getResult());

 // Update the property. The field still displays the old value.
 doc.getBuiltInDocumentProperties().setAuthor("John & Jane Doe");

 Assert.assertEquals("John Doe", field.getResult());

 // Since the field's value is out of date, we can mark it as "dirty".
 // This value will stay out of date until we update the field manually with the Field.Update() method.
 field.isDirty(true);

 // If we save without calling an update method,
 // the field will keep displaying the out of date value in the output document.
 doc.save(getArtifactsDir() + "Filed.UpdateDirtyFields.docx");

 // The LoadOptions object has an option to update all fields
 // marked as "dirty" when loading the document.
 LoadOptions options = new LoadOptions();
 options.setUpdateDirtyFields(updateDirtyFields);

 doc = new Document(getArtifactsDir() + "Filed.UpdateDirtyFields.docx", options);

 Assert.assertEquals("John & Jane Doe", doc.getBuiltInDocumentProperties().getAuthor());

 field = (FieldAuthor) doc.getRange().getFields().get(0);

 // Updating dirty fields like this automatically set their "IsDirty" flag to false.
 if (updateDirtyFields) {
     Assert.assertEquals("John & Jane Doe", field.getResult());
     Assert.assertFalse(field.isDirty());
 } else {
     Assert.assertEquals("John Doe", field.getResult());
     Assert.assertTrue(field.isDirty());
 }

Returns: boolean - Whether the current result of the field is no longer correct (stale) due to other modifications made to the document.

isDirty(boolean value)

public void isDirty(boolean value)

Sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.

Examples:

Shows how to use special property for updating field result.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Give the document's built-in "Author" property value, and then display it with a field.
 doc.getBuiltInDocumentProperties().setAuthor("John Doe");
 FieldAuthor field = (FieldAuthor) builder.insertField(FieldType.FIELD_AUTHOR, true);

 Assert.assertFalse(field.isDirty());
 Assert.assertEquals("John Doe", field.getResult());

 // Update the property. The field still displays the old value.
 doc.getBuiltInDocumentProperties().setAuthor("John & Jane Doe");

 Assert.assertEquals("John Doe", field.getResult());

 // Since the field's value is out of date, we can mark it as "dirty".
 // This value will stay out of date until we update the field manually with the Field.Update() method.
 field.isDirty(true);

 // If we save without calling an update method,
 // the field will keep displaying the out of date value in the output document.
 doc.save(getArtifactsDir() + "Filed.UpdateDirtyFields.docx");

 // The LoadOptions object has an option to update all fields
 // marked as "dirty" when loading the document.
 LoadOptions options = new LoadOptions();
 options.setUpdateDirtyFields(updateDirtyFields);

 doc = new Document(getArtifactsDir() + "Filed.UpdateDirtyFields.docx", options);

 Assert.assertEquals("John & Jane Doe", doc.getBuiltInDocumentProperties().getAuthor());

 field = (FieldAuthor) doc.getRange().getFields().get(0);

 // Updating dirty fields like this automatically set their "IsDirty" flag to false.
 if (updateDirtyFields) {
     Assert.assertEquals("John & Jane Doe", field.getResult());
     Assert.assertFalse(field.isDirty());
 } else {
     Assert.assertEquals("John Doe", field.getResult());
     Assert.assertTrue(field.isDirty());
 }

Parameters:

ParameterTypeDescription
valuebooleanWhether the current result of the field is no longer correct (stale) due to other modifications made to the document.

isLocked()

public boolean isLocked()

Gets whether the field is locked (should not recalculate its result).

Examples:

Shows how to work with a FieldStart node.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldDate field = (FieldDate) builder.insertField(FieldType.FIELD_DATE, true);
 field.getFormat().setDateTimeFormat("dddd, MMMM dd, yyyy");
 field.update();

 FieldChar fieldStart = field.getStart();

 Assert.assertEquals(FieldType.FIELD_DATE, fieldStart.getFieldType());
 Assert.assertEquals(false, fieldStart.isDirty());
 Assert.assertEquals(false, fieldStart.isLocked());

 // Retrieve the facade object which represents the field in the document.
 field = (FieldDate) fieldStart.getField();

 Assert.assertEquals(false, field.isLocked());
 Assert.assertEquals(" DATE  \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode());

 // Update the field to show the current date.
 field.update();

Returns: boolean - Whether the field is locked (should not recalculate its result).

isLocked(boolean value)

public void isLocked(boolean value)

Sets whether the field is locked (should not recalculate its result).

Examples:

Shows how to work with a FieldStart node.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldDate field = (FieldDate) builder.insertField(FieldType.FIELD_DATE, true);
 field.getFormat().setDateTimeFormat("dddd, MMMM dd, yyyy");
 field.update();

 FieldChar fieldStart = field.getStart();

 Assert.assertEquals(FieldType.FIELD_DATE, fieldStart.getFieldType());
 Assert.assertEquals(false, fieldStart.isDirty());
 Assert.assertEquals(false, fieldStart.isLocked());

 // Retrieve the facade object which represents the field in the document.
 field = (FieldDate) fieldStart.getField();

 Assert.assertEquals(false, field.isLocked());
 Assert.assertEquals(" DATE  \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode());

 // Update the field to show the current date.
 field.update();

Parameters:

ParameterTypeDescription
valuebooleanWhether the field is locked (should not recalculate its result).

remove()

public Node remove()

Removes the field from the document. Returns a node right after the field. If the field’s end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null .

Examples:

Shows how to remove fields from a field collection.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
 builder.insertField(" TIME ");
 builder.insertField(" REVNUM ");
 builder.insertField(" AUTHOR  \"John Doe\" ");
 builder.insertField(" SUBJECT \"My Subject\" ");
 builder.insertField(" QUOTE \"Hello world!\" ");
 doc.updateFields();

 FieldCollection fields = doc.getRange().getFields();

 Assert.assertEquals(6, fields.getCount());

 // Below are four ways of removing fields from a field collection.
 // 1 -  Get a field to remove itself:
 fields.get(0).remove();
 Assert.assertEquals(5, fields.getCount());

 // 2 -  Get the collection to remove a field that we pass to its removal method:
 Field lastField = fields.get(3);
 fields.remove(lastField);
 Assert.assertEquals(4, fields.getCount());

 // 3 -  Remove a field from a collection at an index:
 fields.removeAt(2);
 Assert.assertEquals(3, fields.getCount());

 // 4 -  Remove all the fields from the collection at once:
 fields.clear();
 Assert.assertEquals(0, fields.getCount());

Shows how to process PRIVATE fields.


 public void fieldPrivate() throws Exception {
     // Open a Corel WordPerfect document which we have converted to .docx format.
     Document doc = new Document(getMyDir() + "Field sample - PRIVATE.docx");

     // WordPerfect 5.x/6.x documents like the one we have loaded may contain PRIVATE fields.
     // Microsoft Word preserves PRIVATE fields during load/save operations,
     // but provides no functionality for them.
     FieldPrivate field = (FieldPrivate) doc.getRange().getFields().get(0);

     Assert.assertEquals(" PRIVATE \"My value\" ", field.getFieldCode());
     Assert.assertEquals(FieldType.FIELD_PRIVATE, field.getType());

     // We can also insert PRIVATE fields using a document builder.
     DocumentBuilder builder = new DocumentBuilder(doc);
     builder.insertField(FieldType.FIELD_PRIVATE, true);

     // These fields are not a viable way of protecting sensitive information.
     // Unless backward compatibility with older versions of WordPerfect is essential,
     // we can safely remove these fields. We can do this using a DocumentVisiitor implementation.
     Assert.assertEquals(2, doc.getRange().getFields().getCount());

     FieldPrivateRemover remover = new FieldPrivateRemover();
     doc.accept(remover);

     Assert.assertEquals(remover.getFieldsRemovedCount(), 2);
     Assert.assertEquals(doc.getRange().getFields().getCount(), 0);
 }

 /// 
 /// Removes all encountered PRIVATE fields.
 /// 
 public static class FieldPrivateRemover extends DocumentVisitor {
     public FieldPrivateRemover() {
         mFieldsRemovedCount = 0;
     }

     public int getFieldsRemovedCount() {
         return mFieldsRemovedCount;
     }

     /// 
     /// Called when a FieldEnd node is encountered in the document.
     /// If the node belongs to a PRIVATE field, the entire field is removed.
     /// 
     public int visitFieldEnd(final FieldEnd fieldEnd) throws Exception {
         if (fieldEnd.getFieldType() == FieldType.FIELD_PRIVATE) {
             fieldEnd.getField().remove();
             mFieldsRemovedCount++;
         }

         return VisitorAction.CONTINUE;
     }

     private int mFieldsRemovedCount;
 }

Returns: Node

setComparisonOperator(String value)

public void setComparisonOperator(String value)

Sets the comparison operator.

Examples:

Shows how to skip pages in a mail merge using the SKIPIF field.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert a SKIPIF field. If the current row of a mail merge operation fulfills the condition
 // which the expressions of this field state, then the mail merge operation aborts the current row,
 // discards the current merge document, and then immediately moves to the next row to begin the next merge document.
 FieldSkipIf fieldSkipIf = (FieldSkipIf) builder.insertField(FieldType.FIELD_SKIP_IF, true);

 // Move the builder to the SKIPIF field's separator so we can place a MERGEFIELD inside the SKIPIF field.
 builder.moveTo(fieldSkipIf.getSeparator());
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Department");

 // The MERGEFIELD refers to the "Department" column in our data table. If a row from that table
 // has a value of "HR" in its "Department" column, then this row will fulfill the condition.
 fieldSkipIf.setLeftExpression("=");
 fieldSkipIf.setRightExpression("HR");

 // Add content to our document, create the data source, and execute the mail merge.
 builder.moveToDocumentEnd();
 builder.write("Dear ");
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Name");
 builder.writeln(", ");

 // This table has three rows, and one of them fulfills the condition of our SKIPIF field.
 // The mail merge will produce two pages.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Name");
 table.getColumns().add("Department");
 table.getRows().add("John Doe", "Sales");
 table.getRows().add("Jane Doe", "Accounting");
 table.getRows().add("John Cardholder", "HR");

 doc.getMailMerge().execute(table);
 doc.save(getArtifactsDir() + "Field.SKIPIF.docx");

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");

Parameters:

ParameterTypeDescription
valuejava.lang.StringThe comparison operator.

setLeftExpression(String value)

public void setLeftExpression(String value)

Sets the left part of the comparison expression.

Examples:

Shows how to skip pages in a mail merge using the SKIPIF field.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert a SKIPIF field. If the current row of a mail merge operation fulfills the condition
 // which the expressions of this field state, then the mail merge operation aborts the current row,
 // discards the current merge document, and then immediately moves to the next row to begin the next merge document.
 FieldSkipIf fieldSkipIf = (FieldSkipIf) builder.insertField(FieldType.FIELD_SKIP_IF, true);

 // Move the builder to the SKIPIF field's separator so we can place a MERGEFIELD inside the SKIPIF field.
 builder.moveTo(fieldSkipIf.getSeparator());
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Department");

 // The MERGEFIELD refers to the "Department" column in our data table. If a row from that table
 // has a value of "HR" in its "Department" column, then this row will fulfill the condition.
 fieldSkipIf.setLeftExpression("=");
 fieldSkipIf.setRightExpression("HR");

 // Add content to our document, create the data source, and execute the mail merge.
 builder.moveToDocumentEnd();
 builder.write("Dear ");
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Name");
 builder.writeln(", ");

 // This table has three rows, and one of them fulfills the condition of our SKIPIF field.
 // The mail merge will produce two pages.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Name");
 table.getColumns().add("Department");
 table.getRows().add("John Doe", "Sales");
 table.getRows().add("Jane Doe", "Accounting");
 table.getRows().add("John Cardholder", "HR");

 doc.getMailMerge().execute(table);
 doc.save(getArtifactsDir() + "Field.SKIPIF.docx");

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");

Parameters:

ParameterTypeDescription
valuejava.lang.StringThe left part of the comparison expression.

setLocaleId(int value)

public void setLocaleId(int value)

Sets the LCID of the field.

Examples:

Shows how to insert a field and work with its locale.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert a DATE field, and then print the date it will display.
 // Your thread's current culture determines the formatting of the date.
 Field field = builder.insertField("DATE");
 System.out.println(MessageFormat.format("Today''s date, as displayed in the \"{0}\" culture: {1}", Locale.getDefault().getDisplayLanguage(), field.getResult()));

 Assert.assertEquals(1033, field.getLocaleId());
 // Changing the culture of our thread will impact the result of the DATE field.
 // Another way to get the DATE field to display a date in a different culture is to use its LocaleId property.
 // This way allows us to avoid changing the thread's culture to get this effect.
 doc.getFieldOptions().setFieldUpdateCultureSource(FieldUpdateCultureSource.FIELD_CODE);
 CultureInfo de = new CultureInfo("de-DE");
 field.setLocaleId(1031);
 field.update();

 System.out.println(MessageFormat.format("Today''s date, as displayed according to the \"{0}\" culture: {1}", Locale.forLanguageTag(LocaleUtil.getLocaleFromLCID(field.getLocaleId())).getDisplayLanguage(), field.getResult()));

Parameters:

ParameterTypeDescription
valueintThe LCID of the field.

setResult(String value)

public void setResult(String value)

Sets text that is between the field separator and field end.

Examples:

Shows how to insert a field into a document using a field code.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

 Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());
 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());

Parameters:

ParameterTypeDescription
valuejava.lang.StringText that is between the field separator and field end.

setRightExpression(String value)

public void setRightExpression(String value)

Sets the right part of the comparison expression.

Examples:

Shows how to skip pages in a mail merge using the SKIPIF field.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert a SKIPIF field. If the current row of a mail merge operation fulfills the condition
 // which the expressions of this field state, then the mail merge operation aborts the current row,
 // discards the current merge document, and then immediately moves to the next row to begin the next merge document.
 FieldSkipIf fieldSkipIf = (FieldSkipIf) builder.insertField(FieldType.FIELD_SKIP_IF, true);

 // Move the builder to the SKIPIF field's separator so we can place a MERGEFIELD inside the SKIPIF field.
 builder.moveTo(fieldSkipIf.getSeparator());
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Department");

 // The MERGEFIELD refers to the "Department" column in our data table. If a row from that table
 // has a value of "HR" in its "Department" column, then this row will fulfill the condition.
 fieldSkipIf.setLeftExpression("=");
 fieldSkipIf.setRightExpression("HR");

 // Add content to our document, create the data source, and execute the mail merge.
 builder.moveToDocumentEnd();
 builder.write("Dear ");
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Name");
 builder.writeln(", ");

 // This table has three rows, and one of them fulfills the condition of our SKIPIF field.
 // The mail merge will produce two pages.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Name");
 table.getColumns().add("Department");
 table.getRows().add("John Doe", "Sales");
 table.getRows().add("Jane Doe", "Accounting");
 table.getRows().add("John Cardholder", "HR");

 doc.getMailMerge().execute(table);
 doc.save(getArtifactsDir() + "Field.SKIPIF.docx");

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");

Parameters:

ParameterTypeDescription
valuejava.lang.StringThe right part of the comparison expression.
public boolean unlink()

Performs the field unlink.

Remarks:

Replaces the field with its most recent result.

Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.

Examples:

Shows how to unlink a field.


 Document doc = new Document(getMyDir() + "Linked fields.docx");
 doc.getRange().getFields().get(1).unlink();

Returns: boolean - true if the field has been unlinked, otherwise false .

update()

public void update()

Performs the field update. Throws if the field is being updated already.

Examples:

Shows how to insert a field into a document using FieldType.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Insert two fields while passing a flag which determines whether to update them as the builder inserts them.
 // In some cases, updating fields could be computationally expensive, and it may be a good idea to defer the update.
 doc.getBuiltInDocumentProperties().setAuthor("John Doe");
 builder.write("This document was written by ");
 builder.insertField(FieldType.FIELD_AUTHOR, updateInsertedFieldsImmediately);

 builder.insertParagraph();
 builder.write("\nThis is page ");
 builder.insertField(FieldType.FIELD_PAGE, updateInsertedFieldsImmediately);

 Assert.assertEquals(" AUTHOR ", doc.getRange().getFields().get(0).getFieldCode());
 Assert.assertEquals(" PAGE ", doc.getRange().getFields().get(1).getFieldCode());

 if (updateInsertedFieldsImmediately) {
     Assert.assertEquals("John Doe", doc.getRange().getFields().get(0).getResult());
     Assert.assertEquals("1", doc.getRange().getFields().get(1).getResult());
 } else {
     Assert.assertEquals("", doc.getRange().getFields().get(0).getResult());
     Assert.assertEquals("", doc.getRange().getFields().get(1).getResult());

     // We will need to update these fields using the update methods manually.
     doc.getRange().getFields().get(0).update();

     Assert.assertEquals("John Doe", doc.getRange().getFields().get(0).getResult());

     doc.updateFields();

     Assert.assertEquals("1", doc.getRange().getFields().get(1).getResult());
 }

Shows how to format field results.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Use a document builder to insert a field that displays a result with no format applied.
 Field field = builder.insertField("= 2 + 3");

 Assert.assertEquals("= 2 + 3", field.getFieldCode());
 Assert.assertEquals("5", field.getResult());

 // We can apply a format to a field's result using the field's properties.
 // Below are three types of formats that we can apply to a field's result.
 // 1 -  Numeric format:
 FieldFormat format = field.getFormat();
 format.setNumericFormat("$###.00");
 field.update();

 Assert.assertEquals("= 2 + 3 \\# $###.00", field.getFieldCode());
 Assert.assertEquals("$  5.00", field.getResult());

 // 2 -  Date/time format:
 field = builder.insertField("DATE");
 format = field.getFormat();
 format.setDateTimeFormat("dddd, MMMM dd, yyyy");
 field.update();

 Assert.assertEquals("DATE \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode());
 System.out.println("Today's date, in {format.DateTimeFormat} format:\n\t{field.Result}");

 // 3 -  General format:
 field = builder.insertField("= 25 + 33");
 format = field.getFormat();
 format.getGeneralFormats().add(GeneralFormat.LOWERCASE_ROMAN);
 format.getGeneralFormats().add(GeneralFormat.UPPER);
 field.update();

 int index = 0;
 Iterator generalFormatEnumerator = format.getGeneralFormats().iterator();
 while (generalFormatEnumerator.hasNext()) {
     int value = generalFormatEnumerator.next();
     System.out.println(MessageFormat.format("General format index {0}: {1}", index++, value));
 }

 Assert.assertEquals("= 25 + 33 \\* roman \\* Upper", field.getFieldCode());
 Assert.assertEquals("LVIII", field.getResult());
 Assert.assertEquals(2, format.getGeneralFormats().getCount());
 Assert.assertEquals(GeneralFormat.LOWERCASE_ROMAN, format.getGeneralFormats().get(0));

 // We can remove our formats to revert the field's result to its original form.
 format.getGeneralFormats().remove(GeneralFormat.LOWERCASE_ROMAN);
 format.getGeneralFormats().removeAt(0);
 Assert.assertEquals(0, format.getGeneralFormats().getCount());
 field.update();

 Assert.assertEquals("= 25 + 33  ", field.getFieldCode());
 Assert.assertEquals("58", field.getResult());
 Assert.assertEquals(0, format.getGeneralFormats().getCount());

update(boolean ignoreMergeFormat)

public void update(boolean ignoreMergeFormat)

Performs a field update. Throws if the field is being updated already.

Examples:

Shows how to preserve or discard INCLUDEPICTURE fields when loading a document.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldIncludePicture includePicture = (FieldIncludePicture) builder.insertField(FieldType.FIELD_INCLUDE_PICTURE, true);
 includePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");
 includePicture.update(true);

 try (ByteArrayOutputStream docStream = new ByteArrayOutputStream()) {
     doc.save(docStream, new OoxmlSaveOptions(SaveFormat.DOCX));

     // We can set a flag in a LoadOptions object to decide whether to convert all INCLUDEPICTURE fields
     // into image shapes when loading a document that contains them.
     LoadOptions loadOptions = new LoadOptions();
     {
         loadOptions.setPreserveIncludePictureField(preserveIncludePictureField);
     }

     doc = new Document(new ByteArrayInputStream(docStream.toByteArray()), loadOptions);
     FieldCollection fieldCollection = doc.getRange().getFields();

     if (preserveIncludePictureField) {
         Assert.assertTrue(IterableUtils.matchesAny(fieldCollection, f -> f.getType() == FieldType.FIELD_INCLUDE_PICTURE));

         doc.updateFields();
         doc.save(getArtifactsDir() + "Field.PreserveIncludePicture.docx");
     } else {
         Assert.assertFalse(IterableUtils.matchesAny(fieldCollection, f -> f.getType() == FieldType.FIELD_INCLUDE_PICTURE));
     }
 }

Parameters:

ParameterTypeDescription
ignoreMergeFormatbooleanIf true then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.
FieldShape FieldStart