com.aspose.words

Class FieldPageRef

  • java.lang.Object
    • Field
      • com.aspose.words.FieldPageRef
public class FieldPageRef 
extends Field

Implements the PAGEREF field.
Inserts the number of the page containing the specified bookmark for a cross-reference.

Example:

Shows to insert PAGEREF fields and present them in different ways.
public void fieldPageRef() throws Exception {
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    insertAndNameBookmark(builder, "MyBookmark1");

    // This field will display just the page number where the bookmark starts
    // Setting InsertHyperlink attribute makes the field function as a link to the bookmark
    Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark3", true, false, "Hyperlink to Bookmark3, on page: ").getFieldCode(),
            " PAGEREF  MyBookmark3 \\h");

    // Setting the \p flag makes the field display the relative position of the bookmark to the field instead of a page number
    // Bookmark1 is on the same page and above this field, so the result will be "above" on update
    Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark1", true, true, "Bookmark1 is ").getFieldCode(),
            " PAGEREF  MyBookmark1 \\h \\p");

    // Bookmark2 will be on the same page and below this field, so the field will display "below"
    Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark2", true, true, "Bookmark2 is ").getFieldCode(),
            " PAGEREF  MyBookmark2 \\h \\p");

    // Bookmark3 will be on a different page, so the field will display "on page 2"
    Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark3", true, true, "Bookmark3 is ").getFieldCode(),
            " PAGEREF  MyBookmark3 \\h \\p");

    insertAndNameBookmark(builder, "MyBookmark2");
    builder.insertBreak(BreakType.PAGE_BREAK);
    insertAndNameBookmark(builder, "MyBookmark3");

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

/// <summary>
/// Uses a document builder to insert a PAGEREF field and sets its attributes
/// </summary>
private FieldPageRef insertFieldPageRef(final DocumentBuilder builder, final String bookmarkName, final boolean insertHyperlink,
                                        final boolean insertRelativePosition, final String textBefore) throws Exception {
    builder.write(textBefore);

    FieldPageRef field = (FieldPageRef) builder.insertField(FieldType.FIELD_PAGE_REF, true);
    field.setBookmarkName(bookmarkName);
    field.setInsertHyperlink(insertHyperlink);
    field.setInsertRelativePosition(insertRelativePosition);
    builder.writeln();

    return field;
}

/// <summary>
/// Uses a document builder to insert a named bookmark
/// </summary>
private void insertAndNameBookmark(final DocumentBuilder builder, final String bookmarkName) {
    builder.startBookmark(bookmarkName);
    builder.writeln(MessageFormat.format("Contents of bookmark \"{0}\".", bookmarkName));
    builder.endBookmark(bookmarkName);
}

Constructor Summary
 
Property Getters/Setters Summary
java.lang.StringgetBookmarkName()
void
setBookmarkName(java.lang.Stringvalue)
           Gets or sets the name of the bookmark.
java.lang.StringgetDisplayResult()
Gets the text that represents the displayed field result.
FieldEndgetEnd()
Gets the node that represents the field end.
FieldFormatgetFormat()
Gets a FieldFormat object that provides typed access to field's formatting.
booleangetInsertHyperlink()
void
setInsertHyperlink(booleanvalue)
           Gets or sets whether to insert a hyperlink to the bookmarked paragraph.
booleangetInsertRelativePosition()
void
           Gets or sets whether to insert a relative position of the bookmarked paragraph.
booleanisDirty()
void
isDirty(booleanvalue)
           Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
booleanisLocked()
void
isLocked(booleanvalue)
           Gets or sets whether the field is locked (should not recalculate its result).
intgetLocaleId()
void
setLocaleId(intvalue)
           Gets or sets the LCID of the field.
java.lang.StringgetResult()
void
setResult(java.lang.Stringvalue)
           Gets or sets text that is between the field separator and field end.
FieldSeparatorgetSeparator()
Gets the node that represents the field separator. Can be null.
FieldStartgetStart()
Gets the node that represents the start of the field.
intgetType()
Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
 
Method Summary
java.lang.StringgetFieldCode()
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)
Returns text between field start and field separator (or field end if there is no separator).
Noderemove()
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()
Performs the field unlink.
voidupdate()
Performs the field update. Throws if the field is being updated already.
voidupdate(boolean ignoreMergeFormat)
Performs a field update. Throws if the field is being updated already.
 

    • Constructor Detail

      • FieldPageRef

        public FieldPageRef()
    • Property Getters/Setters Detail

      • getBookmarkName/setBookmarkName

        public java.lang.String getBookmarkName() / public void setBookmarkName(java.lang.String value)
        
        Gets or sets the name of the bookmark.

        Example:

        Shows to insert PAGEREF fields and present them in different ways.
        public void fieldPageRef() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            insertAndNameBookmark(builder, "MyBookmark1");
        
            // This field will display just the page number where the bookmark starts
            // Setting InsertHyperlink attribute makes the field function as a link to the bookmark
            Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark3", true, false, "Hyperlink to Bookmark3, on page: ").getFieldCode(),
                    " PAGEREF  MyBookmark3 \\h");
        
            // Setting the \p flag makes the field display the relative position of the bookmark to the field instead of a page number
            // Bookmark1 is on the same page and above this field, so the result will be "above" on update
            Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark1", true, true, "Bookmark1 is ").getFieldCode(),
                    " PAGEREF  MyBookmark1 \\h \\p");
        
            // Bookmark2 will be on the same page and below this field, so the field will display "below"
            Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark2", true, true, "Bookmark2 is ").getFieldCode(),
                    " PAGEREF  MyBookmark2 \\h \\p");
        
            // Bookmark3 will be on a different page, so the field will display "on page 2"
            Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark3", true, true, "Bookmark3 is ").getFieldCode(),
                    " PAGEREF  MyBookmark3 \\h \\p");
        
            insertAndNameBookmark(builder, "MyBookmark2");
            builder.insertBreak(BreakType.PAGE_BREAK);
            insertAndNameBookmark(builder, "MyBookmark3");
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "Field.PageRef.docx");
        }
        
        /// <summary>
        /// Uses a document builder to insert a PAGEREF field and sets its attributes
        /// </summary>
        private FieldPageRef insertFieldPageRef(final DocumentBuilder builder, final String bookmarkName, final boolean insertHyperlink,
                                                final boolean insertRelativePosition, final String textBefore) throws Exception {
            builder.write(textBefore);
        
            FieldPageRef field = (FieldPageRef) builder.insertField(FieldType.FIELD_PAGE_REF, true);
            field.setBookmarkName(bookmarkName);
            field.setInsertHyperlink(insertHyperlink);
            field.setInsertRelativePosition(insertRelativePosition);
            builder.writeln();
        
            return field;
        }
        
        /// <summary>
        /// Uses a document builder to insert a named bookmark
        /// </summary>
        private void insertAndNameBookmark(final DocumentBuilder builder, final String bookmarkName) {
            builder.startBookmark(bookmarkName);
            builder.writeln(MessageFormat.format("Contents of bookmark \"{0}\".", bookmarkName));
            builder.endBookmark(bookmarkName);
        }
      • 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");
      • getInsertHyperlink/setInsertHyperlink

        public boolean getInsertHyperlink() / public void setInsertHyperlink(boolean value)
        
        Gets or sets whether to insert a hyperlink to the bookmarked paragraph.

        Example:

        Shows to insert PAGEREF fields and present them in different ways.
        public void fieldPageRef() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            insertAndNameBookmark(builder, "MyBookmark1");
        
            // This field will display just the page number where the bookmark starts
            // Setting InsertHyperlink attribute makes the field function as a link to the bookmark
            Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark3", true, false, "Hyperlink to Bookmark3, on page: ").getFieldCode(),
                    " PAGEREF  MyBookmark3 \\h");
        
            // Setting the \p flag makes the field display the relative position of the bookmark to the field instead of a page number
            // Bookmark1 is on the same page and above this field, so the result will be "above" on update
            Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark1", true, true, "Bookmark1 is ").getFieldCode(),
                    " PAGEREF  MyBookmark1 \\h \\p");
        
            // Bookmark2 will be on the same page and below this field, so the field will display "below"
            Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark2", true, true, "Bookmark2 is ").getFieldCode(),
                    " PAGEREF  MyBookmark2 \\h \\p");
        
            // Bookmark3 will be on a different page, so the field will display "on page 2"
            Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark3", true, true, "Bookmark3 is ").getFieldCode(),
                    " PAGEREF  MyBookmark3 \\h \\p");
        
            insertAndNameBookmark(builder, "MyBookmark2");
            builder.insertBreak(BreakType.PAGE_BREAK);
            insertAndNameBookmark(builder, "MyBookmark3");
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "Field.PageRef.docx");
        }
        
        /// <summary>
        /// Uses a document builder to insert a PAGEREF field and sets its attributes
        /// </summary>
        private FieldPageRef insertFieldPageRef(final DocumentBuilder builder, final String bookmarkName, final boolean insertHyperlink,
                                                final boolean insertRelativePosition, final String textBefore) throws Exception {
            builder.write(textBefore);
        
            FieldPageRef field = (FieldPageRef) builder.insertField(FieldType.FIELD_PAGE_REF, true);
            field.setBookmarkName(bookmarkName);
            field.setInsertHyperlink(insertHyperlink);
            field.setInsertRelativePosition(insertRelativePosition);
            builder.writeln();
        
            return field;
        }
        
        /// <summary>
        /// Uses a document builder to insert a named bookmark
        /// </summary>
        private void insertAndNameBookmark(final DocumentBuilder builder, final String bookmarkName) {
            builder.startBookmark(bookmarkName);
            builder.writeln(MessageFormat.format("Contents of bookmark \"{0}\".", bookmarkName));
            builder.endBookmark(bookmarkName);
        }
      • getInsertRelativePosition/setInsertRelativePosition

        public boolean getInsertRelativePosition() / public void setInsertRelativePosition(boolean value)
        
        Gets or sets whether to insert a relative position of the bookmarked paragraph.

        Example:

        Shows to insert PAGEREF fields and present them in different ways.
        public void fieldPageRef() throws Exception {
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            insertAndNameBookmark(builder, "MyBookmark1");
        
            // This field will display just the page number where the bookmark starts
            // Setting InsertHyperlink attribute makes the field function as a link to the bookmark
            Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark3", true, false, "Hyperlink to Bookmark3, on page: ").getFieldCode(),
                    " PAGEREF  MyBookmark3 \\h");
        
            // Setting the \p flag makes the field display the relative position of the bookmark to the field instead of a page number
            // Bookmark1 is on the same page and above this field, so the result will be "above" on update
            Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark1", true, true, "Bookmark1 is ").getFieldCode(),
                    " PAGEREF  MyBookmark1 \\h \\p");
        
            // Bookmark2 will be on the same page and below this field, so the field will display "below"
            Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark2", true, true, "Bookmark2 is ").getFieldCode(),
                    " PAGEREF  MyBookmark2 \\h \\p");
        
            // Bookmark3 will be on a different page, so the field will display "on page 2"
            Assert.assertEquals(insertFieldPageRef(builder, "MyBookmark3", true, true, "Bookmark3 is ").getFieldCode(),
                    " PAGEREF  MyBookmark3 \\h \\p");
        
            insertAndNameBookmark(builder, "MyBookmark2");
            builder.insertBreak(BreakType.PAGE_BREAK);
            insertAndNameBookmark(builder, "MyBookmark3");
        
            doc.updateFields();
            doc.save(getArtifactsDir() + "Field.PageRef.docx");
        }
        
        /// <summary>
        /// Uses a document builder to insert a PAGEREF field and sets its attributes
        /// </summary>
        private FieldPageRef insertFieldPageRef(final DocumentBuilder builder, final String bookmarkName, final boolean insertHyperlink,
                                                final boolean insertRelativePosition, final String textBefore) throws Exception {
            builder.write(textBefore);
        
            FieldPageRef field = (FieldPageRef) builder.insertField(FieldType.FIELD_PAGE_REF, true);
            field.setBookmarkName(bookmarkName);
            field.setInsertHyperlink(insertHyperlink);
            field.setInsertRelativePosition(insertRelativePosition);
            builder.writeln();
        
            return field;
        }
        
        /// <summary>
        /// Uses a document builder to insert a named bookmark
        /// </summary>
        private void insertAndNameBookmark(final DocumentBuilder builder, final String bookmarkName) {
            builder.startBookmark(bookmarkName);
            builder.writeln(MessageFormat.format("Contents of bookmark \"{0}\".", bookmarkName));
            builder.endBookmark(bookmarkName);
        }
      • 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();
      • 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;
        }
      • 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");