com.aspose.words

Constructor Detail

• FieldAutoTextList

  public FieldAutoTextList()

Property Getters/Setters Detail

• getEnd

  public FieldEnd getEnd()
  

  Gets the node that represents the field end.

• getEntryName/setEntryName

  public java.lang.String getEntryName() / public void setEntryName(java.lang.String value)
  

  Gets or sets the name of the AutoText entry.

• 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);
  
  Field field = builder.insertField("MERGEFIELD Date");
  
  FieldFormat format = field.getFormat();
  
  format.setDateTimeFormat("dddd, MMMM dd, yyyy");
  format.setNumericFormat("0.#");
  format.getGeneralFormats().add(GeneralFormat.CHAR_FORMAT);

• 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.

• isLocked/isLocked

  public boolean isLocked() / public void isLocked(boolean value)
  

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

• getListStyle/setListStyle

  public java.lang.String getListStyle() / public void setListStyle(java.lang.String value)
  

  Gets or sets the name of the style on which the list to contain entries is based.

• 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.

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

• getScreenTip/setScreenTip

  public java.lang.String getScreenTip() / public void setScreenTip(java.lang.String value)
  

  Gets or sets the text of the ScreenTip to show.

• getSeparator

  public FieldSeparator getSeparator()
  

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

• getStart

  public FieldStart getStart()
  

  Gets the node that represents the start of the field.

• 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.

  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.

  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;
  
          if (containsNestedFields)
          {
              String fieldCode = fieldIf.getFieldCode(true);
          } else
          {
              String 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;
  
          if (containsNestedFields)
          {
              String fieldCode = fieldIf.getFieldCode(true);
          } else
          {
              String 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:

  Inserts a field into a document using DocumentBuilder.

  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.

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