com.aspose.words
Class FieldIf

java.lang.Object
  extended by Field
      extended by com.aspose.words.FieldIf

public class FieldIf 
extends Field

Implements the IF field.

Compares the values designated by the expressions LeftExpression and RightExpression in comparison using the operator designated by ComparisonOperator.

A field in the following format will be used as a mail merge source: { IF 0 = 0 "{PatientsNameFML}" "" \* MERGEFORMAT }

Example:

Shows how to insert an if field.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.write("Statement 1: ");

// Use document builder to insert an if field
FieldIf field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);

// The if field will output either the TrueText or FalseText string into the document, depending on the truth of the statement
// In this case, "0 = 1" is incorrect, so the output will be "False"
field.setLeftExpression("0");
field.setComparisonOperator("=");
field.setRightExpression("1");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  0 = 1 True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.FALSE, field.evaluateCondition());

// This time, the statement is correct, so the output will be "True"
builder.write("\nStatement 2: ");
field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);
field.setLeftExpression("5");
field.setComparisonOperator("=");
field.setRightExpression("2 + 3");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  5 = \"2 + 3\" True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.TRUE, field.evaluateCondition());

doc.updateFields();
doc.save(getArtifactsDir() + "Field.IF.docx");

Constructor Summary
FieldIf()
          
 
Property Getters/Setters Summary
java.lang.StringgetComparisonOperator()
voidsetComparisonOperator(java.lang.String value)
           Gets or sets the comparison operator.
java.lang.StringgetDisplayResult()→ inherited from Field
           Gets the text that represents the displayed field result.
FieldEndgetEnd()→ inherited from Field
           Gets the node that represents the field end.
java.lang.StringgetFalseText()
voidsetFalseText(java.lang.String value)
           Gets or sets the text displayed if the comparison expression is false.
FieldFormatgetFormat()→ inherited from Field
           Gets a FieldFormat object that provides typed access to field's formatting.
booleanisDirty()→ inherited from Field
voidisDirty(boolean value)
           Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
java.lang.StringgetLeftExpression()
voidsetLeftExpression(java.lang.String value)
           Gets or sets the left part of the comparison expression.
intgetLocaleId()→ inherited from Field
voidsetLocaleId(int value)
           Gets or sets the LCID of the field.
java.lang.StringgetResult()→ inherited from Field
voidsetResult(java.lang.String value)
           Gets or sets text that is between the field separator and field end.
java.lang.StringgetRightExpression()
voidsetRightExpression(java.lang.String value)
           Gets or sets the right part of the comparison expression.
FieldSeparatorgetSeparator()→ inherited from Field
           Gets the node that represents the field separator. Can be null.
FieldStartgetStart()→ inherited from Field
           Gets the node that represents the start of the field.
java.lang.StringgetTrueText()
voidsetTrueText(java.lang.String value)
           Gets or sets the text displayed if the comparison expression is true.
intgetType()→ inherited from Field
           Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
 
Method Summary
intevaluateCondition()
           Evaluates the condition.
java.lang.StringgetFieldCode()→ inherited from Field
           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.
java.lang.StringgetFieldCode(boolean includeChildFieldCodes)→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator).
Noderemove()→ inherited from Field
           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.
booleanunlink()→ inherited from Field
           Performs the field unlink.
voidupdate()→ inherited from Field
           Performs the field update. Throws if the field is being updated already.
voidupdate(boolean ignoreMergeFormat)→ inherited from Field
           Performs a field update. Throws if the field is being updated already.
 

Constructor Detail

FieldIf

public FieldIf()

Property Getters/Setters Detail

getComparisonOperator/setComparisonOperator

public java.lang.String getComparisonOperator() / public void setComparisonOperator(java.lang.String value)
Gets or sets the comparison operator.

Example:

Shows how to insert an if field.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.write("Statement 1: ");

// Use document builder to insert an if field
FieldIf field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);

// The if field will output either the TrueText or FalseText string into the document, depending on the truth of the statement
// In this case, "0 = 1" is incorrect, so the output will be "False"
field.setLeftExpression("0");
field.setComparisonOperator("=");
field.setRightExpression("1");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  0 = 1 True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.FALSE, field.evaluateCondition());

// This time, the statement is correct, so the output will be "True"
builder.write("\nStatement 2: ");
field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);
field.setLeftExpression("5");
field.setComparisonOperator("=");
field.setRightExpression("2 + 3");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  5 = \"2 + 3\" True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.TRUE, field.evaluateCondition());

doc.updateFields();
doc.save(getArtifactsDir() + "Field.IF.docx");

getDisplayResult

→ inherited from Field
public java.lang.String getDisplayResult()
Gets the text that represents the displayed field result. The Document.updateListLabels() method must be called to obtain correct value for the FieldListNum, FieldAutoNum, FieldAutoNumOut and FieldAutoNumLgl fields.

Example:

Shows how to get the text that represents the displayed field result.
Document document = new Document(getMyDir() + "Various fields.docx");

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

Assert.assertEquals("111", fields.get(0).getDisplayResult());
Assert.assertEquals("222", fields.get(1).getDisplayResult());
Assert.assertEquals("Multi\rLine\rText", fields.get(2).getDisplayResult());
Assert.assertEquals("%", fields.get(3).getDisplayResult());
Assert.assertEquals("Macro Button Text", fields.get(4).getDisplayResult());
Assert.assertEquals("", fields.get(5).getDisplayResult());

// Method must be called to obtain correct value for the "FieldListNum", "FieldAutoNum",
// "FieldAutoNumOut" and "FieldAutoNumLgl" fields
document.updateListLabels();

Assert.assertEquals("1)", fields.get(5).getDisplayResult());

getEnd

→ inherited from Field
public FieldEnd getEnd()
Gets the node that represents the field end.

Example:

Shows how to work with a document's field collection.
public void fieldCollection() throws Exception {
    // Create a new document and insert some fields
    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();

    // Get the collection that contains all the fields in a document
    FieldCollection fields = doc.getRange().getFields();
    Assert.assertEquals(fields.getCount(), 6);

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

    Iterator<Field> fieldEnumerator = fields.iterator();

    while (fieldEnumerator.hasNext()) {
        if (fieldEnumerator.next() != 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());

    // Get a field to remove itself
    fields.get(0).remove();
    Assert.assertEquals(fields.getCount(), 5);

    // Remove a field by reference
    Field lastField = fields.get(3);
    fields.remove(lastField);
    Assert.assertEquals(fields.getCount(), 4);

    // Remove a field by index
    fields.removeAt(2);
    Assert.assertEquals(fields.getCount(), 3);

    // Remove all fields from the document
    fields.clear();
    Assert.assertEquals(fields.getCount(), 0);
}

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

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

    /// <summary>
    /// Called when a FieldStart node is encountered in the document.
    /// </summary>
    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;
    }

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

        return VisitorAction.CONTINUE;
    }

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

        return VisitorAction.CONTINUE;
    }

    private StringBuilder mBuilder;
}

getFalseText/setFalseText

public java.lang.String getFalseText() / public void setFalseText(java.lang.String value)
Gets or sets the text displayed if the comparison expression is false.

Example:

Shows how to insert an if field.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.write("Statement 1: ");

// Use document builder to insert an if field
FieldIf field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);

// The if field will output either the TrueText or FalseText string into the document, depending on the truth of the statement
// In this case, "0 = 1" is incorrect, so the output will be "False"
field.setLeftExpression("0");
field.setComparisonOperator("=");
field.setRightExpression("1");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  0 = 1 True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.FALSE, field.evaluateCondition());

// This time, the statement is correct, so the output will be "True"
builder.write("\nStatement 2: ");
field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);
field.setLeftExpression("5");
field.setComparisonOperator("=");
field.setRightExpression("2 + 3");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  5 = \"2 + 3\" True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.TRUE, field.evaluateCondition());

doc.updateFields();
doc.save(getArtifactsDir() + "Field.IF.docx");

getFormat

→ inherited from Field
public FieldFormat getFormat()
Gets a FieldFormat object that provides typed access to field's formatting.

Example:

Shows how to format fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

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

// We can format our field here instead of in the field code
FieldFormat format = field.getFormat();
format.setNumericFormat("$###.00");
field.update();

Assert.assertEquals("$  5.00", field.getResult());

// Apply a date/time format
field = builder.insertField("DATE");
format = field.getFormat();
format.setDateTimeFormat("dddd, MMMM dd, yyyy");
field.update();

System.out.println("Today's date, in {format.DateTimeFormat} format:\n\t{field.Result}");

// Apply 2 general formats at the same time
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<Integer> generalFormatEnumerator = format.getGeneralFormats().iterator();
while (generalFormatEnumerator.hasNext()) {
    System.out.println(MessageFormat.format("General format index {0}: {1}", index++, generalFormatEnumerator.toString()));
}

Assert.assertEquals("LVIII", field.getResult());
Assert.assertEquals(2, format.getGeneralFormats().getCount());
Assert.assertEquals(format.getGeneralFormats().get(0), GeneralFormat.LOWERCASE_ROMAN);

// Removing field formats
format.getGeneralFormats().remove(GeneralFormat.LOWERCASE_ROMAN);
format.getGeneralFormats().removeAt(0);
Assert.assertEquals(format.getGeneralFormats().getCount(), 0);
field.update();

// Our field has no general formats left and is back to default form
Assert.assertEquals(field.getResult(), "58");

isDirty/isDirty

→ inherited from Field
public boolean isDirty() / public void isDirty(boolean value)
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.

Example:

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 property "Author" a value and 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 "Author" property
doc.getBuiltInDocumentProperties().setAuthor("John & Jane Doe");

// AUTHOR is one of the field types whose fields do not update according to their source values in real time,
// and need to be updated manually beforehand every time an accurate value is required
Assert.assertEquals("John Doe", field.getResult());

// Since the field's value is out of date, we can mark it as "Dirty"
field.isDirty(true);

OutputStream docStream = new FileOutputStream(getArtifactsDir() + "Filed.UpdateDirtyFields.docx");
try {
    doc.save(docStream, SaveFormat.DOCX);

    // Re-open the document from the stream while using a LoadOptions object to specify
    // whether to update all fields marked as "Dirty" in the process, so they can display accurate values immediately
    LoadOptions options = new LoadOptions();
    options.setUpdateDirtyFields(doUpdateDirtyFields);

    doc = new Document(String.valueOf(docStream), options);

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

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

    if (doUpdateDirtyFields) {
        Assert.assertEquals("John & Jane Doe", field.getResult());
        Assert.assertFalse(field.isDirty());
    } else {
        Assert.assertEquals("John Doe", field.getResult());
        Assert.assertTrue(field.isDirty());
    }
} finally {
    if (docStream != null) docStream.close();
}

isLocked/isLocked

→ inherited from Field
public boolean isLocked() / public void isLocked(boolean value)
Gets or sets whether the field is locked (should not recalculate its result).

Example:

Demonstrates how to retrieve the field class from an existing FieldStart node in the document.
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());

// This updates only this field in the document
field.update();

getLeftExpression/setLeftExpression

public java.lang.String getLeftExpression() / public void setLeftExpression(java.lang.String value)
Gets or sets the left part of the comparison expression.

Example:

Shows how to insert an if field.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.write("Statement 1: ");

// Use document builder to insert an if field
FieldIf field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);

// The if field will output either the TrueText or FalseText string into the document, depending on the truth of the statement
// In this case, "0 = 1" is incorrect, so the output will be "False"
field.setLeftExpression("0");
field.setComparisonOperator("=");
field.setRightExpression("1");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  0 = 1 True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.FALSE, field.evaluateCondition());

// This time, the statement is correct, so the output will be "True"
builder.write("\nStatement 2: ");
field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);
field.setLeftExpression("5");
field.setComparisonOperator("=");
field.setRightExpression("2 + 3");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  5 = \"2 + 3\" True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.TRUE, field.evaluateCondition());

doc.updateFields();
doc.save(getArtifactsDir() + "Field.IF.docx");

getLocaleId/setLocaleId

→ inherited from Field
public int getLocaleId() / public void setLocaleId(int value)
Gets or sets the LCID of the field.

Example:

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 print the date it will display, formatted according to your thread's current culture
Field field = builder.insertField("DATE");
System.out.println(MessageFormat.format("Today's date, as displayed in the \"{0}\" culture: {1}", Locale.getDefault().getDisplayName(), field.getResult()));

Assert.assertEquals(1033, field.getLocaleId());

// We can get the field to display a date in a different format if we change the current thread's culture
// If we want to avoid making such an all encompassing change,
// we can set this option to get the document's fields to get their culture from themselves
// Then, we can change a field's LocaleId and it will display its result in any culture we choose
doc.getFieldOptions().setFieldUpdateCultureSource(FieldUpdateCultureSource.FIELD_CODE);
field.setLocaleId(1031);
field.update();

System.out.println(MessageFormat.format("Today's date, as displayed according to the \"{0}\" culture: {1}", field.getLocaleId(), field.getResult()));
See Also:
FieldUpdateCultureSource.FIELD_CODE

getResult/setResult

→ inherited from Field
public java.lang.String getResult() / public void setResult(java.lang.String value)
Gets or sets text that is between the field separator and field end.

Example:

Shows how to insert a field into a document by FieldCode.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult
dateField.update();

// Display some information from this field
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing
Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult());

// Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9
Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate" 
Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object
dateField.remove();

getRightExpression/setRightExpression

public java.lang.String getRightExpression() / public void setRightExpression(java.lang.String value)
Gets or sets the right part of the comparison expression.

Example:

Shows how to insert an if field.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.write("Statement 1: ");

// Use document builder to insert an if field
FieldIf field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);

// The if field will output either the TrueText or FalseText string into the document, depending on the truth of the statement
// In this case, "0 = 1" is incorrect, so the output will be "False"
field.setLeftExpression("0");
field.setComparisonOperator("=");
field.setRightExpression("1");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  0 = 1 True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.FALSE, field.evaluateCondition());

// This time, the statement is correct, so the output will be "True"
builder.write("\nStatement 2: ");
field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);
field.setLeftExpression("5");
field.setComparisonOperator("=");
field.setRightExpression("2 + 3");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  5 = \"2 + 3\" True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.TRUE, field.evaluateCondition());

doc.updateFields();
doc.save(getArtifactsDir() + "Field.IF.docx");

getSeparator

→ inherited from Field
public FieldSeparator getSeparator()
Gets the node that represents the field separator. Can be null.

Example:

Shows how to work with a document's field collection.
public void fieldCollection() throws Exception {
    // Create a new document and insert some fields
    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();

    // Get the collection that contains all the fields in a document
    FieldCollection fields = doc.getRange().getFields();
    Assert.assertEquals(fields.getCount(), 6);

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

    Iterator<Field> fieldEnumerator = fields.iterator();

    while (fieldEnumerator.hasNext()) {
        if (fieldEnumerator.next() != 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());

    // Get a field to remove itself
    fields.get(0).remove();
    Assert.assertEquals(fields.getCount(), 5);

    // Remove a field by reference
    Field lastField = fields.get(3);
    fields.remove(lastField);
    Assert.assertEquals(fields.getCount(), 4);

    // Remove a field by index
    fields.removeAt(2);
    Assert.assertEquals(fields.getCount(), 3);

    // Remove all fields from the document
    fields.clear();
    Assert.assertEquals(fields.getCount(), 0);
}

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

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

    /// <summary>
    /// Called when a FieldStart node is encountered in the document.
    /// </summary>
    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;
    }

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

        return VisitorAction.CONTINUE;
    }

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

        return VisitorAction.CONTINUE;
    }

    private StringBuilder mBuilder;
}

getStart

→ inherited from Field
public FieldStart getStart()
Gets the node that represents the start of the field.

Example:

Shows how to work with a document's field collection.
public void fieldCollection() throws Exception {
    // Create a new document and insert some fields
    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();

    // Get the collection that contains all the fields in a document
    FieldCollection fields = doc.getRange().getFields();
    Assert.assertEquals(fields.getCount(), 6);

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

    Iterator<Field> fieldEnumerator = fields.iterator();

    while (fieldEnumerator.hasNext()) {
        if (fieldEnumerator.next() != 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());

    // Get a field to remove itself
    fields.get(0).remove();
    Assert.assertEquals(fields.getCount(), 5);

    // Remove a field by reference
    Field lastField = fields.get(3);
    fields.remove(lastField);
    Assert.assertEquals(fields.getCount(), 4);

    // Remove a field by index
    fields.removeAt(2);
    Assert.assertEquals(fields.getCount(), 3);

    // Remove all fields from the document
    fields.clear();
    Assert.assertEquals(fields.getCount(), 0);
}

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

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

    /// <summary>
    /// Called when a FieldStart node is encountered in the document.
    /// </summary>
    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;
    }

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

        return VisitorAction.CONTINUE;
    }

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

        return VisitorAction.CONTINUE;
    }

    private StringBuilder mBuilder;
}

getTrueText/setTrueText

public java.lang.String getTrueText() / public void setTrueText(java.lang.String value)
Gets or sets the text displayed if the comparison expression is true.

Example:

Shows how to insert an if field.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.write("Statement 1: ");

// Use document builder to insert an if field
FieldIf field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);

// The if field will output either the TrueText or FalseText string into the document, depending on the truth of the statement
// In this case, "0 = 1" is incorrect, so the output will be "False"
field.setLeftExpression("0");
field.setComparisonOperator("=");
field.setRightExpression("1");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  0 = 1 True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.FALSE, field.evaluateCondition());

// This time, the statement is correct, so the output will be "True"
builder.write("\nStatement 2: ");
field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);
field.setLeftExpression("5");
field.setComparisonOperator("=");
field.setRightExpression("2 + 3");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  5 = \"2 + 3\" True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.TRUE, field.evaluateCondition());

doc.updateFields();
doc.save(getArtifactsDir() + "Field.IF.docx");

getType

→ inherited from Field
public int getType()
Gets the Microsoft Word field type. The value of the property is FieldType integer constant.

Example:

Shows how to insert a field into a document by FieldCode.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult
dateField.update();

// Display some information from this field
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing
Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult());

// Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9
Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate" 
Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object
dateField.remove();

Method Detail

evaluateCondition

public int evaluateCondition()
                     throws java.lang.Exception
Evaluates the condition.
Returns:
A FieldIfComparisonResult value. A FieldIfComparisonResult value that represents the result of the condition evaluation.

Example:

Shows how to insert an if field.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.write("Statement 1: ");

// Use document builder to insert an if field
FieldIf field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);

// The if field will output either the TrueText or FalseText string into the document, depending on the truth of the statement
// In this case, "0 = 1" is incorrect, so the output will be "False"
field.setLeftExpression("0");
field.setComparisonOperator("=");
field.setRightExpression("1");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  0 = 1 True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.FALSE, field.evaluateCondition());

// This time, the statement is correct, so the output will be "True"
builder.write("\nStatement 2: ");
field = (FieldIf) builder.insertField(FieldType.FIELD_IF, true);
field.setLeftExpression("5");
field.setComparisonOperator("=");
field.setRightExpression("2 + 3");
field.setTrueText("True");
field.setFalseText("False");

Assert.assertEquals(" IF  5 = \"2 + 3\" True False", field.getFieldCode());
Assert.assertEquals(FieldIfComparisonResult.TRUE, field.evaluateCondition());

doc.updateFields();
doc.save(getArtifactsDir() + "Field.IF.docx");

getFieldCode

→ inherited from Field
public java.lang.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.

Example:

Shows how to insert a field into a document by FieldCode.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult
dateField.update();

// Display some information from this field
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing
Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult());

// Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9
Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate" 
Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object
dateField.remove();

Example:

Shows how to get text between field start and field separator (or field end if there is no separator).
// Open a document which contains a MERGEFIELD inside an IF field
Document doc = new Document(getMyDir() + "Nested fields.docx");

// Get the outer IF field and print its full field code
FieldIf fieldIf = (FieldIf) doc.getRange().getFields().get(0);
System.out.println("Full field code including child fields:\n\t{fieldIf.GetFieldCode()}");

// All inner nested fields are printed by default
Assert.assertEquals(fieldIf.getFieldCode(), fieldIf.getFieldCode(true));

// Print the field code again but this time without the inner MERGEFIELD
System.out.println("Field code with nested fields omitted:\n\t{fieldIf.GetFieldCode(false)}");

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode(boolean includeChildFieldCodes)
Returns text between field start and field separator (or field end if there is no separator).
Parameters:
includeChildFieldCodes - True if child field codes should be included.

Example:

Shows how to get text between field start and field separator (or field end if there is no separator).
// Open a document which contains a MERGEFIELD inside an IF field
Document doc = new Document(getMyDir() + "Nested fields.docx");

// Get the outer IF field and print its full field code
FieldIf fieldIf = (FieldIf) doc.getRange().getFields().get(0);
System.out.println("Full field code including child fields:\n\t{fieldIf.GetFieldCode()}");

// All inner nested fields are printed by default
Assert.assertEquals(fieldIf.getFieldCode(), fieldIf.getFieldCode(true));

// Print the field code again but this time without the inner MERGEFIELD
System.out.println("Field code with nested fields omitted:\n\t{fieldIf.GetFieldCode(false)}");

remove

→ inherited from Field
public Node remove()
           throws java.lang.Exception
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.

Example:

Shows how to work with a document's field collection.
public void fieldCollection() throws Exception {
    // Create a new document and insert some fields
    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();

    // Get the collection that contains all the fields in a document
    FieldCollection fields = doc.getRange().getFields();
    Assert.assertEquals(fields.getCount(), 6);

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

    Iterator<Field> fieldEnumerator = fields.iterator();

    while (fieldEnumerator.hasNext()) {
        if (fieldEnumerator.next() != 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());

    // Get a field to remove itself
    fields.get(0).remove();
    Assert.assertEquals(fields.getCount(), 5);

    // Remove a field by reference
    Field lastField = fields.get(3);
    fields.remove(lastField);
    Assert.assertEquals(fields.getCount(), 4);

    // Remove a field by index
    fields.removeAt(2);
    Assert.assertEquals(fields.getCount(), 3);

    // Remove all fields from the document
    fields.clear();
    Assert.assertEquals(fields.getCount(), 0);
}

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

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

    /// <summary>
    /// Called when a FieldStart node is encountered in the document.
    /// </summary>
    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;
    }

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

        return VisitorAction.CONTINUE;
    }

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

        return VisitorAction.CONTINUE;
    }

    private StringBuilder mBuilder;
}

Example:

Shows how to insert a field into a document by FieldCode.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult
dateField.update();

// Display some information from this field
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing
Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult());

// Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9
Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate" 
Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object
dateField.remove();

unlink

→ inherited from Field
public boolean unlink()
              throws java.lang.Exception
Performs the field unlink.

Replaces the field with its most recent result.

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

Returns:
True if the field has been unlinked, otherwise false.

Example:

Shows how to unlink specific field.
Document doc = new Document(getMyDir() + "Linked fields.docx");
doc.getRange().getFields().get(1).unlink();

update

→ inherited from Field
public void update()
           throws java.lang.Exception
Performs the field update. Throws if the field is being updated already.

Example:

Shows how to insert a field into a document by FieldCode.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult
dateField.update();

// Display some information from this field
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing
Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult());

// Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9
Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate" 
Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object
dateField.remove();

update

→ inherited from Field
public void update(boolean ignoreMergeFormat)
           throws java.lang.Exception
Performs a field update. Throws if the field is being updated already.
Parameters:
ignoreMergeFormat - If true then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.

Example:

Shows a way to update a field ignoring the MERGEFORMAT switch.
LoadOptions loadOptions = new LoadOptions();
{
    loadOptions.setPreserveIncludePictureField(true);
}
Document doc = new Document(getMyDir() + "Field sample - INCLUDEPICTURE.docx", loadOptions);

for (Field field : doc.getRange().getFields()) {
    if (((field.getType()) == (FieldType.FIELD_INCLUDE_PICTURE))) {
        FieldIncludePicture includePicture = (FieldIncludePicture) field;
        includePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");
        includePicture.update(true);

        doc.updateFields();
        doc.save(getArtifactsDir() + "Field.UpdateFieldIgnoringMergeFormat.docx");

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.