com.aspose.words

Constructor Detail

• FieldListNum

  public FieldListNum()

Property Getters/Setters Detail

• getDisplayResult

  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.

• getEnd

  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 {
      // Open a document that has fields
      Document doc = new Document(getMyDir() + "Document.ContainsFields.docx");
  
      // 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;
  }

• getFormat

  public FieldFormat getFormat()
  

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

  Example:

  Shows how to formatting 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();
  
  // Apply a date/time format
  field = builder.insertField("DATE");
  format = field.getFormat();
  format.setDateTimeFormat("dddd, MMMM dd, yyyy");
  field.update();
  
  // 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");

• hasListName

  public boolean hasListName()
  

  Returns a value indicating whether the name of an abstract numbering definition is provided by the field's code.

  Example:

  Shows how to number paragraphs with LISTNUM fields.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a list num field using a document builder
  FieldListNum fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  
  // Lists start counting at 1 by default, but we can change this number at any time
  // In this case, we'll do a zero-based count
  fieldListNum.setStartingNumber("0");
  builder.writeln("Paragraph 1");
  
  // Placing several list num fields in one paragraph increases the list level instead of the current number, in this case resulting in "1)a)i)", list level 3
  builder.insertField(FieldType.FIELD_LIST_NUM, true);
  builder.insertField(FieldType.FIELD_LIST_NUM, true);
  builder.insertField(FieldType.FIELD_LIST_NUM, true);
  builder.writeln("Paragraph 2");
  
  // The list level resets with new paragraphs, so to keep counting at a desired list level, we need to set the ListLevel property accordingly
  fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  fieldListNum.setListLevel("3");
  builder.writeln("Paragraph 3");
  
  fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  
  // Setting this property to this particular value will emulate the AUTONUMOUT field
  fieldListNum.setListName("OutlineDefault");
  Assert.assertTrue(fieldListNum.hasListName());
  
  // Start counting from 1
  fieldListNum.setStartingNumber("1");
  builder.writeln("Paragraph 4");
  
  // Our fields keep track of the count automatically, but the ListName needs to be set with each new field
  fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  fieldListNum.setListName("OutlineDefault");
  builder.writeln("Paragraph 5");
  
  doc.updateFields();
  doc.save(getArtifactsDir() + "Field.FieldListNum.docx");

• isDirty/isDirty

  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);
  
  Field fieldToc = builder.insertTableOfContents("\\o \"1-3\" \\h \\z \\u");
  fieldToc.isDirty(true);

• isLocked/isLocked

  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(getMyDir() + "Document.TableOfContents.doc");
  
  FieldChar fieldStart = (FieldChar) doc.getChild(NodeType.FIELD_START, 0, true);
  Assert.assertEquals(fieldStart.getFieldType(), FieldType.FIELD_TOC);
  Assert.assertEquals(fieldStart.isDirty(), true);
  Assert.assertEquals(fieldStart.isLocked(), false);
  
  // Retrieve the facade object which represents the field in the document.
  Field field = fieldStart.getField();
  
  Assert.assertEquals(false, field.isLocked());
  Assert.assertEquals(" TOC \\o \"1-3\" \\h \\z \\u ", field.getFieldCode());
  
  // This updates only this field in the document.
  field.update();

• getListLevel/setListLevel

  public java.lang.String getListLevel() / public void setListLevel(java.lang.String value)
  

  Gets or sets the level in the list, overriding the default behavior of the field.

  Example:

  Shows how to number paragraphs with LISTNUM fields.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a list num field using a document builder
  FieldListNum fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  
  // Lists start counting at 1 by default, but we can change this number at any time
  // In this case, we'll do a zero-based count
  fieldListNum.setStartingNumber("0");
  builder.writeln("Paragraph 1");
  
  // Placing several list num fields in one paragraph increases the list level instead of the current number, in this case resulting in "1)a)i)", list level 3
  builder.insertField(FieldType.FIELD_LIST_NUM, true);
  builder.insertField(FieldType.FIELD_LIST_NUM, true);
  builder.insertField(FieldType.FIELD_LIST_NUM, true);
  builder.writeln("Paragraph 2");
  
  // The list level resets with new paragraphs, so to keep counting at a desired list level, we need to set the ListLevel property accordingly
  fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  fieldListNum.setListLevel("3");
  builder.writeln("Paragraph 3");
  
  fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  
  // Setting this property to this particular value will emulate the AUTONUMOUT field
  fieldListNum.setListName("OutlineDefault");
  Assert.assertTrue(fieldListNum.hasListName());
  
  // Start counting from 1
  fieldListNum.setStartingNumber("1");
  builder.writeln("Paragraph 4");
  
  // Our fields keep track of the count automatically, but the ListName needs to be set with each new field
  fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  fieldListNum.setListName("OutlineDefault");
  builder.writeln("Paragraph 5");
  
  doc.updateFields();
  doc.save(getArtifactsDir() + "Field.FieldListNum.docx");

• getListName/setListName

  public java.lang.String getListName() / public void setListName(java.lang.String value)
  

  Gets or sets the name of the abstract numbering definition used for the numbering.

  Example:

  Shows how to number paragraphs with LISTNUM fields.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a list num field using a document builder
  FieldListNum fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  
  // Lists start counting at 1 by default, but we can change this number at any time
  // In this case, we'll do a zero-based count
  fieldListNum.setStartingNumber("0");
  builder.writeln("Paragraph 1");
  
  // Placing several list num fields in one paragraph increases the list level instead of the current number, in this case resulting in "1)a)i)", list level 3
  builder.insertField(FieldType.FIELD_LIST_NUM, true);
  builder.insertField(FieldType.FIELD_LIST_NUM, true);
  builder.insertField(FieldType.FIELD_LIST_NUM, true);
  builder.writeln("Paragraph 2");
  
  // The list level resets with new paragraphs, so to keep counting at a desired list level, we need to set the ListLevel property accordingly
  fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  fieldListNum.setListLevel("3");
  builder.writeln("Paragraph 3");
  
  fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  
  // Setting this property to this particular value will emulate the AUTONUMOUT field
  fieldListNum.setListName("OutlineDefault");
  Assert.assertTrue(fieldListNum.hasListName());
  
  // Start counting from 1
  fieldListNum.setStartingNumber("1");
  builder.writeln("Paragraph 4");
  
  // Our fields keep track of the count automatically, but the ListName needs to be set with each new field
  fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  fieldListNum.setListName("OutlineDefault");
  builder.writeln("Paragraph 5");
  
  doc.updateFields();
  doc.save(getArtifactsDir() + "Field.FieldListNum.docx");

• getLocaleId/setLocaleId

  public int getLocaleId() / public void setLocaleId(int value)
  

  Gets or sets the LCID of the field.

  Example:

  Get or sets locale for fields

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Field field = builder.insertField("DATE \\* MERGEFORMAT");
  field.setLocaleId(2064);
  
  ByteArrayOutputStream dstStream = new ByteArrayOutputStream();
  doc.save(dstStream, SaveFormat.DOCX);
  
  Field newField = doc.getRange().getFields().get(0);
  Assert.assertEquals(newField.getLocaleId(), 2064);

  See Also:

  FieldUpdateCultureSource.FIELD_CODE

• getResult/setResult

  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:

  Inserts a field into a document using DocumentBuilder and 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.
  System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));
  
  // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
  System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));
  
  // The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
  System.out.println(MessageFormat.format("FieldType: {0}", 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();

• getSeparator

  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 {
      // Open a document that has fields
      Document doc = new Document(getMyDir() + "Document.ContainsFields.docx");
  
      // 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

  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 {
      // Open a document that has fields
      Document doc = new Document(getMyDir() + "Document.ContainsFields.docx");
  
      // 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;
  }

• getStartingNumber/setStartingNumber

  public java.lang.String getStartingNumber() / public void setStartingNumber(java.lang.String value)
  

  Gets or sets the starting value for this field.

  Example:

  Shows how to number paragraphs with LISTNUM fields.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a list num field using a document builder
  FieldListNum fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  
  // Lists start counting at 1 by default, but we can change this number at any time
  // In this case, we'll do a zero-based count
  fieldListNum.setStartingNumber("0");
  builder.writeln("Paragraph 1");
  
  // Placing several list num fields in one paragraph increases the list level instead of the current number, in this case resulting in "1)a)i)", list level 3
  builder.insertField(FieldType.FIELD_LIST_NUM, true);
  builder.insertField(FieldType.FIELD_LIST_NUM, true);
  builder.insertField(FieldType.FIELD_LIST_NUM, true);
  builder.writeln("Paragraph 2");
  
  // The list level resets with new paragraphs, so to keep counting at a desired list level, we need to set the ListLevel property accordingly
  fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  fieldListNum.setListLevel("3");
  builder.writeln("Paragraph 3");
  
  fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  
  // Setting this property to this particular value will emulate the AUTONUMOUT field
  fieldListNum.setListName("OutlineDefault");
  Assert.assertTrue(fieldListNum.hasListName());
  
  // Start counting from 1
  fieldListNum.setStartingNumber("1");
  builder.writeln("Paragraph 4");
  
  // Our fields keep track of the count automatically, but the ListName needs to be set with each new field
  fieldListNum = (FieldListNum) builder.insertField(FieldType.FIELD_LIST_NUM, true);
  fieldListNum.setListName("OutlineDefault");
  builder.writeln("Paragraph 5");
  
  doc.updateFields();
  doc.save(getArtifactsDir() + "Field.FieldListNum.docx");

• getType

  public int getType()
  

  Gets the Microsoft Word field type. The value of the property is FieldType integer constant.

  Example:

  Inserts a field into a document using DocumentBuilder and 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.
  System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));
  
  // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
  System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));
  
  // The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
  System.out.println(MessageFormat.format("FieldType: {0}", 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

• getFieldCode

  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:

  Inserts a field into a document using DocumentBuilder and 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.
  System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));
  
  // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
  System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));
  
  // The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
  System.out.println(MessageFormat.format("FieldType: {0}", 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)

  Document doc = new Document(getMyDir() + "Field.FieldCode.docx");
  
  for (Field field : doc.getRange().getFields()) {
      if (field.getType() == FieldType.FIELD_IF) {
          FieldIf fieldIf = (FieldIf) field;
  
          String fieldCode = fieldIf.getFieldCode();
  
          if (containsNestedFields) {
              fieldCode = fieldIf.getFieldCode(true);
          } else {
              fieldCode = fieldIf.getFieldCode(false);
          }
      }
  }

• getFieldCode

  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)

  Document doc = new Document(getMyDir() + "Field.FieldCode.docx");
  
  for (Field field : doc.getRange().getFields()) {
      if (field.getType() == FieldType.FIELD_IF) {
          FieldIf fieldIf = (FieldIf) field;
  
          String fieldCode = fieldIf.getFieldCode();
  
          if (containsNestedFields) {
              fieldCode = fieldIf.getFieldCode(true);
          } else {
              fieldCode = fieldIf.getFieldCode(false);
          }
      }
  }

• remove

  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 {
      // Open a document that has fields
      Document doc = new Document(getMyDir() + "Document.ContainsFields.docx");
  
      // 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:

  Inserts a field into a document using DocumentBuilder and 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.
  System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));
  
  // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
  System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));
  
  // The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
  System.out.println(MessageFormat.format("FieldType: {0}", 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

  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() + "Field.UnlinkFields.docx");
  
  doc.getRange().getFields().get(1).unlink();

• update

  public void update()
             throws java.lang.Exception

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

  Example:

  Inserts a field into a document using DocumentBuilder and 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.
  System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));
  
  // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
  System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));
  
  // The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
  System.out.println(MessageFormat.format("FieldType: {0}", 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

  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.UpdateFieldIgnoringMergeFormat.docx", loadOptions);
  
  for (Field field : doc.getRange().getFields()) {
      if (((field.getType()) == (FieldType.FIELD_INCLUDE_PICTURE))) {
          FieldIncludePicture includePicture = (FieldIncludePicture) field;
          includePicture.setSourceFullName(getImageDir() + "dotnet-logo.png");
          includePicture.update(true);
      }
  }
  
  doc.updateFields();
  doc.save(getArtifactsDir() + "Field.UpdateFieldIgnoringMergeFormat.docx");