com.aspose.words

Class FieldXE

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

Implements the XE field.
Defines the text and page number for an index entry, which is used by an INDEX field.

Example:

Shows how to omit entries while populating an INDEX field with entries from XE fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an INDEX field which will display the page locations of XE fields in the document body
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Set these attributes so that an XE field shows up in the INDEX field's result
// only if it is within the bounds of a bookmark named "MainBookmark", and is of type "A"
index.setBookmarkName("MainBookmark");
index.setEntryType("A");

Assert.assertEquals(" INDEX  \\b MainBookmark \\f A", index.getFieldCode());

// Our index will take up the first page
builder.insertBreak(BreakType.PAGE_BREAK);

// Start the bookmark that will contain all eligible XE entries
builder.startBookmark("MainBookmark");

// This entry will be picked up by the INDEX field because it is inside the bookmark
// and its type matches the INDEX field's type
// Note that even though the type is a string, it is defined by only the first character
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("A");

Assert.assertEquals(" XE  \"Index entry 1\" \\f A", indexEntry.getFieldCode());

// Insert an XE field that will not appear in the INDEX field because it is of the wrong type
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("B");

// End the bookmark and insert an XE field afterwards
// It is of the same type as the INDEX field, but will not appear since it is outside of the bookmark
// Note that the INDEX field itself does not have to be within its bookmark
builder.endBookmark("MainBookmark");
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("A");

doc.updateFields();
doc.save(getArtifactsDir() + "Field.INDEX.XE.Filtering.docx");

Example:

Shows how to modify an INDEX field's appearance while populating it with XE field entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an INDEX field which will display the page locations of XE fields in the document body
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);
index.setLanguageId("1033");

// Setting this attribute's value to "A" will group all the entries by their first letter
// and place that letter in uppercase above each group
index.setHeading("A");

// Set the table created by the INDEX field to span over 2 columns
index.setNumberOfColumns("2");

// Set any entries with starting letters outside the "a-c" character range to be omitted
index.setLetterRange("a-c");

Assert.assertEquals(" INDEX  \\z 1033 \\h A \\c 2 \\p a-c", index.getFieldCode());

// These next two XE fields will show up under the "A" heading,
// with their respective text stylings also applied to their page numbers 
builder.insertBreak(BreakType.PAGE_BREAK);
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Apple");
indexEntry.isItalic(true);

Assert.assertEquals(" XE  Apple \\i", indexEntry.getFieldCode());

builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Apricot");
indexEntry.isBold(true);

Assert.assertEquals(" XE  Apricot \\b", indexEntry.getFieldCode());

// Both the next two XE fields will be under a "B" and "C" heading in the INDEX fields table of contents
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Banana");

builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Cherry");

// All INDEX field entries are sorted alphabetically, so this entry will show up under "A" with the other two
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Avocado");

// This entry will be excluded because, starting with the letter "D", it is outside the "a-c" range
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Durian");

doc.updateFields();
doc.save(getArtifactsDir() + "Field.INDEX.XE.Formatting.docx");

Constructor Summary
 
Property Getters/Setters Summary
java.lang.StringgetDisplayResult()
Gets the text that represents the displayed field result.
FieldEndgetEnd()
Gets the node that represents the field end.
java.lang.StringgetEntryType()
void
setEntryType(java.lang.Stringvalue)
           Gets or sets an index entry type.
FieldFormatgetFormat()
Gets a FieldFormat object that provides typed access to field's formatting.
booleanhasPageRangeBookmarkName()
Gets a value indicating whether a page range bookmark name is provided through the field's code.
booleanisBold()
void
isBold(booleanvalue)
           Gets or sets whether to apply bold formatting to the entry's page number.
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.
booleanisItalic()
void
isItalic(booleanvalue)
           Gets or sets whether to apply italic formatting to the entry's page number.
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.StringgetPageNumberReplacement()
void
setPageNumberReplacement(java.lang.Stringvalue)
           Gets or sets text used in place of a page number.
java.lang.StringgetPageRangeBookmarkName()
void
setPageRangeBookmarkName(java.lang.Stringvalue)
           Gets or sets the name of the bookmark that marks a range of pages that is inserted as the entry's page number.
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.
java.lang.StringgetText()
void
setText(java.lang.Stringvalue)
           Gets or sets the text of the entry.
intgetType()
Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
java.lang.StringgetYomi()
void
setYomi(java.lang.Stringvalue)
           Gets or sets the yomi (first phonetic character for sorting indexes) for the index entry
 
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

      • FieldXE

        public FieldXE()
    • 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.

        Example:

        Shows how to get the text that represents the displayed field result.
        Document document = new Document(getMyDir() + "Various fields.docx");
        
        FieldCollection fields = document.getRange().getFields();
        
        Assert.assertEquals("111", fields.get(0).getDisplayResult());
        Assert.assertEquals("222", fields.get(1).getDisplayResult());
        Assert.assertEquals("Multi\rLine\rText", fields.get(2).getDisplayResult());
        Assert.assertEquals("%", fields.get(3).getDisplayResult());
        Assert.assertEquals("Macro Button Text", fields.get(4).getDisplayResult());
        Assert.assertEquals("", fields.get(5).getDisplayResult());
        
        // Method must be called to obtain correct value for the "FieldListNum", "FieldAutoNum",
        // "FieldAutoNumOut" and "FieldAutoNumLgl" fields
        document.updateListLabels();
        
        Assert.assertEquals("1)", fields.get(5).getDisplayResult());
      • getEnd

        public FieldEnd getEnd()
        
        Gets the node that represents the field end.

        Example:

        Shows how to work with a document's field collection.
        public void fieldCollection() throws Exception {
            // Create a new document and insert some fields
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
            builder.insertField(" TIME ");
            builder.insertField(" REVNUM ");
            builder.insertField(" AUTHOR  \"John Doe\" ");
            builder.insertField(" SUBJECT \"My Subject\" ");
            builder.insertField(" QUOTE \"Hello world!\" ");
            doc.updateFields();
        
            // Get the collection that contains all the fields in a document
            FieldCollection fields = doc.getRange().getFields();
            Assert.assertEquals(fields.getCount(), 6);
        
            // Iterate over the field collection and print contents and type of every field using a custom visitor implementation
            FieldVisitor fieldVisitor = new FieldVisitor();
        
            Iterator<Field> fieldEnumerator = fields.iterator();
        
            while (fieldEnumerator.hasNext()) {
                if (fieldEnumerator.next() != null) {
                    Field currentField = fieldEnumerator.next();
        
                    currentField.getStart().accept(fieldVisitor);
                    if (currentField.getSeparator() != null) {
                        currentField.getSeparator().accept(fieldVisitor);
                    }
                    currentField.getEnd().accept(fieldVisitor);
                } else {
                    System.out.println("There are no fields in the document.");
                }
            }
        
            System.out.println(fieldVisitor.getText());
        
            // Get a field to remove itself
            fields.get(0).remove();
            Assert.assertEquals(fields.getCount(), 5);
        
            // Remove a field by reference
            Field lastField = fields.get(3);
            fields.remove(lastField);
            Assert.assertEquals(fields.getCount(), 4);
        
            // Remove a field by index
            fields.removeAt(2);
            Assert.assertEquals(fields.getCount(), 3);
        
            // Remove all fields from the document
            fields.clear();
            Assert.assertEquals(fields.getCount(), 0);
        }
        
        /// <summary>
        /// Document visitor implementation that prints field info.
        /// </summary>
        public static class FieldVisitor extends DocumentVisitor {
            public FieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            /// <summary>
            /// Called when a FieldStart node is encountered in the document.
            /// </summary>
            public int visitFieldStart(final FieldStart fieldStart) {
                mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n");
                mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n");
                mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a FieldSeparator node is encountered in the document.
            /// </summary>
            public int visitFieldSeparator(final FieldSeparator fieldSeparator) {
                mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a FieldEnd node is encountered in the document.
            /// </summary>
            public int visitFieldEnd(final FieldEnd fieldEnd) {
                mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            private StringBuilder mBuilder;
        }
      • getEntryType/setEntryType

        public java.lang.String getEntryType() / public void setEntryType(java.lang.String value)
        
        Gets or sets an index entry type.

        Example:

        Shows how to omit entries while populating an INDEX field with entries from XE fields.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create an INDEX field which will display the page locations of XE fields in the document body
        FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);
        
        // Set these attributes so that an XE field shows up in the INDEX field's result
        // only if it is within the bounds of a bookmark named "MainBookmark", and is of type "A"
        index.setBookmarkName("MainBookmark");
        index.setEntryType("A");
        
        Assert.assertEquals(" INDEX  \\b MainBookmark \\f A", index.getFieldCode());
        
        // Our index will take up the first page
        builder.insertBreak(BreakType.PAGE_BREAK);
        
        // Start the bookmark that will contain all eligible XE entries
        builder.startBookmark("MainBookmark");
        
        // This entry will be picked up by the INDEX field because it is inside the bookmark
        // and its type matches the INDEX field's type
        // Note that even though the type is a string, it is defined by only the first character
        FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Index entry 1");
        indexEntry.setEntryType("A");
        
        Assert.assertEquals(" XE  \"Index entry 1\" \\f A", indexEntry.getFieldCode());
        
        // Insert an XE field that will not appear in the INDEX field because it is of the wrong type
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Index entry 2");
        indexEntry.setEntryType("B");
        
        // End the bookmark and insert an XE field afterwards
        // It is of the same type as the INDEX field, but will not appear since it is outside of the bookmark
        // Note that the INDEX field itself does not have to be within its bookmark
        builder.endBookmark("MainBookmark");
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Index entry 3");
        indexEntry.setEntryType("A");
        
        doc.updateFields();
        doc.save(getArtifactsDir() + "Field.INDEX.XE.Filtering.docx");
      • getFormat

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

        Example:

        Shows how to format fields.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Use a document builder to insert field with no format
        Field field = builder.insertField("= 2 + 3");
        
        // We can format our field here instead of in the field code
        FieldFormat format = field.getFormat();
        format.setNumericFormat("$###.00");
        field.update();
        
        Assert.assertEquals("$  5.00", field.getResult());
        
        // Apply a date/time format
        field = builder.insertField("DATE");
        format = field.getFormat();
        format.setDateTimeFormat("dddd, MMMM dd, yyyy");
        field.update();
        
        System.out.println("Today's date, in {format.DateTimeFormat} format:\n\t{field.Result}");
        
        // Apply 2 general formats at the same time
        field = builder.insertField("= 25 + 33");
        format = field.getFormat();
        format.getGeneralFormats().add(GeneralFormat.LOWERCASE_ROMAN);
        format.getGeneralFormats().add(GeneralFormat.UPPER);
        field.update();
        
        int index = 0;
        Iterator<Integer> generalFormatEnumerator = format.getGeneralFormats().iterator();
        while (generalFormatEnumerator.hasNext()) {
            System.out.println(MessageFormat.format("General format index {0}: {1}", index++, generalFormatEnumerator.toString()));
        }
        
        Assert.assertEquals("LVIII", field.getResult());
        Assert.assertEquals(2, format.getGeneralFormats().getCount());
        Assert.assertEquals(format.getGeneralFormats().get(0), GeneralFormat.LOWERCASE_ROMAN);
        
        // Removing field formats
        format.getGeneralFormats().remove(GeneralFormat.LOWERCASE_ROMAN);
        format.getGeneralFormats().removeAt(0);
        Assert.assertEquals(format.getGeneralFormats().getCount(), 0);
        field.update();
        
        // Our field has no general formats left and is back to default form
        Assert.assertEquals(field.getResult(), "58");
      • hasPageRangeBookmarkName

        public boolean hasPageRangeBookmarkName()
        
        Gets a value indicating whether a page range bookmark name is provided through the field's code.

        Example:

        Shows how to specify a bookmark's spanned pages as a page range for an INDEX field entry.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create an INDEX field which will display the page locations of XE fields in the document body
        FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);
        
        index.setPageNumberSeparator(", on page(s) ");
        index.setPageRangeSeparator(" to ");
        
        Assert.assertEquals(" INDEX  \\e \", on page(s) \" \\g \" to \"", index.getFieldCode());
        
        // Insert an XE field on page 2
        builder.insertBreak(BreakType.PAGE_BREAK);
        FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("My entry");
        
        // If we use this attribute to refer to a bookmark,
        // this XE field's page number will be substituted by the page range that the referenced bookmark spans 
        indexEntry.setPageRangeBookmarkName("MyBookmark");
        
        Assert.assertEquals(" XE  \"My entry\" \\r MyBookmark", indexEntry.getFieldCode());
        Assert.assertTrue(indexEntry.hasPageRangeBookmarkName());
        
        // Insert a bookmark that starts on page 3 and ends on page 5
        // Since the XE field references this bookmark,
        // its location page number will show up in the INDEX field's table as "3 to 5" instead of "2",
        // which is its actual page
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.startBookmark("MyBookmark");
        builder.write("Start of MyBookmark");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.write("End of MyBookmark");
        builder.endBookmark("MyBookmark");
        
        doc.updateFields();
        doc.save(getArtifactsDir() + "Field.INDEX.XE.PageRangeBookmark.docx");
      • isBold/isBold

        public boolean isBold() / public void isBold(boolean value)
        
        Gets or sets whether to apply bold formatting to the entry's page number.

        Example:

        Shows how to modify an INDEX field's appearance while populating it with XE field entries.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create an INDEX field which will display the page locations of XE fields in the document body
        FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);
        index.setLanguageId("1033");
        
        // Setting this attribute's value to "A" will group all the entries by their first letter
        // and place that letter in uppercase above each group
        index.setHeading("A");
        
        // Set the table created by the INDEX field to span over 2 columns
        index.setNumberOfColumns("2");
        
        // Set any entries with starting letters outside the "a-c" character range to be omitted
        index.setLetterRange("a-c");
        
        Assert.assertEquals(" INDEX  \\z 1033 \\h A \\c 2 \\p a-c", index.getFieldCode());
        
        // These next two XE fields will show up under the "A" heading,
        // with their respective text stylings also applied to their page numbers 
        builder.insertBreak(BreakType.PAGE_BREAK);
        FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Apple");
        indexEntry.isItalic(true);
        
        Assert.assertEquals(" XE  Apple \\i", indexEntry.getFieldCode());
        
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Apricot");
        indexEntry.isBold(true);
        
        Assert.assertEquals(" XE  Apricot \\b", indexEntry.getFieldCode());
        
        // Both the next two XE fields will be under a "B" and "C" heading in the INDEX fields table of contents
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Banana");
        
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Cherry");
        
        // All INDEX field entries are sorted alphabetically, so this entry will show up under "A" with the other two
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Avocado");
        
        // This entry will be excluded because, starting with the letter "D", it is outside the "a-c" range
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Durian");
        
        doc.updateFields();
        doc.save(getArtifactsDir() + "Field.INDEX.XE.Formatting.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);
        
        // Give the document's built in property "Author" a value and display it with a field
        doc.getBuiltInDocumentProperties().setAuthor("John Doe");
        FieldAuthor field = (FieldAuthor) builder.insertField(FieldType.FIELD_AUTHOR, true);
        
        Assert.assertFalse(field.isDirty());
        Assert.assertEquals("John Doe", field.getResult());
        
        // Update the "Author" property
        doc.getBuiltInDocumentProperties().setAuthor("John & Jane Doe");
        
        // AUTHOR is one of the field types whose fields do not update according to their source values in real time,
        // and need to be updated manually beforehand every time an accurate value is required
        Assert.assertEquals("John Doe", field.getResult());
        
        // Since the field's value is out of date, we can mark it as "Dirty"
        field.isDirty(true);
        
        OutputStream docStream = new FileOutputStream(getArtifactsDir() + "Filed.UpdateDirtyFields.docx");
        try {
            doc.save(docStream, SaveFormat.DOCX);
        
            // Re-open the document from the stream while using a LoadOptions object to specify
            // whether to update all fields marked as "Dirty" in the process, so they can display accurate values immediately
            LoadOptions options = new LoadOptions();
            options.setUpdateDirtyFields(doUpdateDirtyFields);
        
            doc = new Document(String.valueOf(docStream), options);
        
            Assert.assertEquals("John & Jane Doe", doc.getBuiltInDocumentProperties().getAuthor());
        
            field = (FieldAuthor) doc.getRange().getFields().get(0);
        
            if (doUpdateDirtyFields) {
                Assert.assertEquals("John & Jane Doe", field.getResult());
                Assert.assertFalse(field.isDirty());
            } else {
                Assert.assertEquals("John Doe", field.getResult());
                Assert.assertTrue(field.isDirty());
            }
        } finally {
            if (docStream != null) docStream.close();
        }
      • isItalic/isItalic

        public boolean isItalic() / public void isItalic(boolean value)
        
        Gets or sets whether to apply italic formatting to the entry's page number.

        Example:

        Shows how to modify an INDEX field's appearance while populating it with XE field entries.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create an INDEX field which will display the page locations of XE fields in the document body
        FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);
        index.setLanguageId("1033");
        
        // Setting this attribute's value to "A" will group all the entries by their first letter
        // and place that letter in uppercase above each group
        index.setHeading("A");
        
        // Set the table created by the INDEX field to span over 2 columns
        index.setNumberOfColumns("2");
        
        // Set any entries with starting letters outside the "a-c" character range to be omitted
        index.setLetterRange("a-c");
        
        Assert.assertEquals(" INDEX  \\z 1033 \\h A \\c 2 \\p a-c", index.getFieldCode());
        
        // These next two XE fields will show up under the "A" heading,
        // with their respective text stylings also applied to their page numbers 
        builder.insertBreak(BreakType.PAGE_BREAK);
        FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Apple");
        indexEntry.isItalic(true);
        
        Assert.assertEquals(" XE  Apple \\i", indexEntry.getFieldCode());
        
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Apricot");
        indexEntry.isBold(true);
        
        Assert.assertEquals(" XE  Apricot \\b", indexEntry.getFieldCode());
        
        // Both the next two XE fields will be under a "B" and "C" heading in the INDEX fields table of contents
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Banana");
        
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Cherry");
        
        // All INDEX field entries are sorted alphabetically, so this entry will show up under "A" with the other two
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Avocado");
        
        // This entry will be excluded because, starting with the letter "D", it is outside the "a-c" range
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Durian");
        
        doc.updateFields();
        doc.save(getArtifactsDir() + "Field.INDEX.XE.Formatting.docx");
      • 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();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        FieldDate field = (FieldDate) builder.insertField(FieldType.FIELD_DATE, true);
        field.getFormat().setDateTimeFormat("dddd, MMMM dd, yyyy");
        field.update();
        
        FieldChar fieldStart = field.getStart();
        Assert.assertEquals(FieldType.FIELD_DATE, fieldStart.getFieldType());
        Assert.assertEquals(false, fieldStart.isDirty());
        Assert.assertEquals(false, fieldStart.isLocked());
        
        // Retrieve the facade object which represents the field in the document
        field = (FieldDate) fieldStart.getField();
        
        Assert.assertEquals(false, field.isLocked());
        Assert.assertEquals(" DATE  \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode());
        
        // This updates only this field in the document
        field.update();
      • getLocaleId/setLocaleId

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

        Example:

        Shows how to insert a field and work with its locale.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a DATE field and print the date it will display, formatted according to your thread's current culture
        Field field = builder.insertField("DATE");
        System.out.println(MessageFormat.format("Today's date, as displayed in the \"{0}\" culture: {1}", Locale.getDefault().getDisplayName(), field.getResult()));
        
        Assert.assertEquals(1033, field.getLocaleId());
        
        // We can get the field to display a date in a different format if we change the current thread's culture
        // If we want to avoid making such an all encompassing change,
        // we can set this option to get the document's fields to get their culture from themselves
        // Then, we can change a field's LocaleId and it will display its result in any culture we choose
        doc.getFieldOptions().setFieldUpdateCultureSource(FieldUpdateCultureSource.FIELD_CODE);
        field.setLocaleId(1031);
        field.update();
        
        System.out.println(MessageFormat.format("Today's date, as displayed according to the \"{0}\" culture: {1}", field.getLocaleId(), field.getResult()));
        See Also:
        FieldUpdateCultureSource.FIELD_CODE
      • getPageNumberReplacement/setPageNumberReplacement

        public java.lang.String getPageNumberReplacement() / public void setPageNumberReplacement(java.lang.String value)
        
        Gets or sets text used in place of a page number.

        Example:

        Shows how to define cross references in an INDEX field.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create an INDEX field which will display the page locations of XE fields in the document body
        FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);
        
        // Define a custom separator that is applied if an XE field contains a page number replacement
        index.setCrossReferenceSeparator(", see: ");
        
        Assert.assertEquals(" INDEX  \\k \", see: \"", index.getFieldCode());
        
        // Insert an XE field on page 2
        // That page number, together with the field's Text attribute, will show up as a table of contents entry in the INDEX field,
        builder.insertBreak(BreakType.PAGE_BREAK);
        FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Apple");
        
        Assert.assertEquals(" XE  Apple", indexEntry.getFieldCode());
        
        // Insert another XE field on page 3, and set a value for "PageNumberReplacement"
        // In the INDEX field's table, this field will display the value of that attribute after the field's CrossReferenceSeparator instead of the page number
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Banana");
        indexEntry.setPageNumberReplacement("Tropical fruit");
        
        Assert.assertEquals(" XE  Banana \\t \"Tropical fruit\"", indexEntry.getFieldCode());
        
        doc.updateFields();
        doc.save(getArtifactsDir() + "Field.INDEX.XE.CrossReferenceSeparator.docx");
      • getPageRangeBookmarkName/setPageRangeBookmarkName

        public java.lang.String getPageRangeBookmarkName() / public void setPageRangeBookmarkName(java.lang.String value)
        
        Gets or sets the name of the bookmark that marks a range of pages that is inserted as the entry's page number.

        Example:

        Shows how to specify a bookmark's spanned pages as a page range for an INDEX field entry.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create an INDEX field which will display the page locations of XE fields in the document body
        FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);
        
        index.setPageNumberSeparator(", on page(s) ");
        index.setPageRangeSeparator(" to ");
        
        Assert.assertEquals(" INDEX  \\e \", on page(s) \" \\g \" to \"", index.getFieldCode());
        
        // Insert an XE field on page 2
        builder.insertBreak(BreakType.PAGE_BREAK);
        FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("My entry");
        
        // If we use this attribute to refer to a bookmark,
        // this XE field's page number will be substituted by the page range that the referenced bookmark spans 
        indexEntry.setPageRangeBookmarkName("MyBookmark");
        
        Assert.assertEquals(" XE  \"My entry\" \\r MyBookmark", indexEntry.getFieldCode());
        Assert.assertTrue(indexEntry.hasPageRangeBookmarkName());
        
        // Insert a bookmark that starts on page 3 and ends on page 5
        // Since the XE field references this bookmark,
        // its location page number will show up in the INDEX field's table as "3 to 5" instead of "2",
        // which is its actual page
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.startBookmark("MyBookmark");
        builder.write("Start of MyBookmark");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.write("End of MyBookmark");
        builder.endBookmark("MyBookmark");
        
        doc.updateFields();
        doc.save(getArtifactsDir() + "Field.INDEX.XE.PageRangeBookmark.docx");
      • 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:

        Shows how to insert a field into a document by FieldCode.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a simple Date field into the document
        // When we insert a field through the DocumentBuilder class we can get the
        // special Field object which contains information about the field
        Field dateField = builder.insertField("DATE \\* MERGEFORMAT");
        
        // Update this particular field in the document so we can get the FieldResult
        dateField.update();
        
        // Display some information from this field
        // The field result is where the last evaluated value is stored. This is what is displayed in the document
        // When field codes are not showing
        Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult());
        
        // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9
        Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());
        
        // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" 
        Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());
        
        // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object
        dateField.remove();
      • 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 {
            // Create a new document and insert some fields
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
            builder.insertField(" TIME ");
            builder.insertField(" REVNUM ");
            builder.insertField(" AUTHOR  \"John Doe\" ");
            builder.insertField(" SUBJECT \"My Subject\" ");
            builder.insertField(" QUOTE \"Hello world!\" ");
            doc.updateFields();
        
            // Get the collection that contains all the fields in a document
            FieldCollection fields = doc.getRange().getFields();
            Assert.assertEquals(fields.getCount(), 6);
        
            // Iterate over the field collection and print contents and type of every field using a custom visitor implementation
            FieldVisitor fieldVisitor = new FieldVisitor();
        
            Iterator<Field> fieldEnumerator = fields.iterator();
        
            while (fieldEnumerator.hasNext()) {
                if (fieldEnumerator.next() != null) {
                    Field currentField = fieldEnumerator.next();
        
                    currentField.getStart().accept(fieldVisitor);
                    if (currentField.getSeparator() != null) {
                        currentField.getSeparator().accept(fieldVisitor);
                    }
                    currentField.getEnd().accept(fieldVisitor);
                } else {
                    System.out.println("There are no fields in the document.");
                }
            }
        
            System.out.println(fieldVisitor.getText());
        
            // Get a field to remove itself
            fields.get(0).remove();
            Assert.assertEquals(fields.getCount(), 5);
        
            // Remove a field by reference
            Field lastField = fields.get(3);
            fields.remove(lastField);
            Assert.assertEquals(fields.getCount(), 4);
        
            // Remove a field by index
            fields.removeAt(2);
            Assert.assertEquals(fields.getCount(), 3);
        
            // Remove all fields from the document
            fields.clear();
            Assert.assertEquals(fields.getCount(), 0);
        }
        
        /// <summary>
        /// Document visitor implementation that prints field info.
        /// </summary>
        public static class FieldVisitor extends DocumentVisitor {
            public FieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            /// <summary>
            /// Called when a FieldStart node is encountered in the document.
            /// </summary>
            public int visitFieldStart(final FieldStart fieldStart) {
                mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n");
                mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n");
                mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a FieldSeparator node is encountered in the document.
            /// </summary>
            public int visitFieldSeparator(final FieldSeparator fieldSeparator) {
                mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a FieldEnd node is encountered in the document.
            /// </summary>
            public int visitFieldEnd(final FieldEnd fieldEnd) {
                mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            private StringBuilder mBuilder;
        }
      • getStart

        public FieldStart getStart()
        
        Gets the node that represents the start of the field.

        Example:

        Shows how to work with a document's field collection.
        public void fieldCollection() throws Exception {
            // Create a new document and insert some fields
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
            builder.insertField(" TIME ");
            builder.insertField(" REVNUM ");
            builder.insertField(" AUTHOR  \"John Doe\" ");
            builder.insertField(" SUBJECT \"My Subject\" ");
            builder.insertField(" QUOTE \"Hello world!\" ");
            doc.updateFields();
        
            // Get the collection that contains all the fields in a document
            FieldCollection fields = doc.getRange().getFields();
            Assert.assertEquals(fields.getCount(), 6);
        
            // Iterate over the field collection and print contents and type of every field using a custom visitor implementation
            FieldVisitor fieldVisitor = new FieldVisitor();
        
            Iterator<Field> fieldEnumerator = fields.iterator();
        
            while (fieldEnumerator.hasNext()) {
                if (fieldEnumerator.next() != null) {
                    Field currentField = fieldEnumerator.next();
        
                    currentField.getStart().accept(fieldVisitor);
                    if (currentField.getSeparator() != null) {
                        currentField.getSeparator().accept(fieldVisitor);
                    }
                    currentField.getEnd().accept(fieldVisitor);
                } else {
                    System.out.println("There are no fields in the document.");
                }
            }
        
            System.out.println(fieldVisitor.getText());
        
            // Get a field to remove itself
            fields.get(0).remove();
            Assert.assertEquals(fields.getCount(), 5);
        
            // Remove a field by reference
            Field lastField = fields.get(3);
            fields.remove(lastField);
            Assert.assertEquals(fields.getCount(), 4);
        
            // Remove a field by index
            fields.removeAt(2);
            Assert.assertEquals(fields.getCount(), 3);
        
            // Remove all fields from the document
            fields.clear();
            Assert.assertEquals(fields.getCount(), 0);
        }
        
        /// <summary>
        /// Document visitor implementation that prints field info.
        /// </summary>
        public static class FieldVisitor extends DocumentVisitor {
            public FieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            /// <summary>
            /// Called when a FieldStart node is encountered in the document.
            /// </summary>
            public int visitFieldStart(final FieldStart fieldStart) {
                mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n");
                mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n");
                mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a FieldSeparator node is encountered in the document.
            /// </summary>
            public int visitFieldSeparator(final FieldSeparator fieldSeparator) {
                mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a FieldEnd node is encountered in the document.
            /// </summary>
            public int visitFieldEnd(final FieldEnd fieldEnd) {
                mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            private StringBuilder mBuilder;
        }
      • getText/setText

        public java.lang.String getText() / public void setText(java.lang.String value)
        
        Gets or sets the text of the entry.

        Example:

        Shows how to omit entries while populating an INDEX field with entries from XE fields.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create an INDEX field which will display the page locations of XE fields in the document body
        FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);
        
        // Set these attributes so that an XE field shows up in the INDEX field's result
        // only if it is within the bounds of a bookmark named "MainBookmark", and is of type "A"
        index.setBookmarkName("MainBookmark");
        index.setEntryType("A");
        
        Assert.assertEquals(" INDEX  \\b MainBookmark \\f A", index.getFieldCode());
        
        // Our index will take up the first page
        builder.insertBreak(BreakType.PAGE_BREAK);
        
        // Start the bookmark that will contain all eligible XE entries
        builder.startBookmark("MainBookmark");
        
        // This entry will be picked up by the INDEX field because it is inside the bookmark
        // and its type matches the INDEX field's type
        // Note that even though the type is a string, it is defined by only the first character
        FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Index entry 1");
        indexEntry.setEntryType("A");
        
        Assert.assertEquals(" XE  \"Index entry 1\" \\f A", indexEntry.getFieldCode());
        
        // Insert an XE field that will not appear in the INDEX field because it is of the wrong type
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Index entry 2");
        indexEntry.setEntryType("B");
        
        // End the bookmark and insert an XE field afterwards
        // It is of the same type as the INDEX field, but will not appear since it is outside of the bookmark
        // Note that the INDEX field itself does not have to be within its bookmark
        builder.endBookmark("MainBookmark");
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Index entry 3");
        indexEntry.setEntryType("A");
        
        doc.updateFields();
        doc.save(getArtifactsDir() + "Field.INDEX.XE.Filtering.docx");

        Example:

        Shows how to modify an INDEX field's appearance while populating it with XE field entries.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create an INDEX field which will display the page locations of XE fields in the document body
        FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);
        index.setLanguageId("1033");
        
        // Setting this attribute's value to "A" will group all the entries by their first letter
        // and place that letter in uppercase above each group
        index.setHeading("A");
        
        // Set the table created by the INDEX field to span over 2 columns
        index.setNumberOfColumns("2");
        
        // Set any entries with starting letters outside the "a-c" character range to be omitted
        index.setLetterRange("a-c");
        
        Assert.assertEquals(" INDEX  \\z 1033 \\h A \\c 2 \\p a-c", index.getFieldCode());
        
        // These next two XE fields will show up under the "A" heading,
        // with their respective text stylings also applied to their page numbers 
        builder.insertBreak(BreakType.PAGE_BREAK);
        FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Apple");
        indexEntry.isItalic(true);
        
        Assert.assertEquals(" XE  Apple \\i", indexEntry.getFieldCode());
        
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Apricot");
        indexEntry.isBold(true);
        
        Assert.assertEquals(" XE  Apricot \\b", indexEntry.getFieldCode());
        
        // Both the next two XE fields will be under a "B" and "C" heading in the INDEX fields table of contents
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Banana");
        
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Cherry");
        
        // All INDEX field entries are sorted alphabetically, so this entry will show up under "A" with the other two
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Avocado");
        
        // This entry will be excluded because, starting with the letter "D", it is outside the "a-c" range
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("Durian");
        
        doc.updateFields();
        doc.save(getArtifactsDir() + "Field.INDEX.XE.Formatting.docx");
      • getType

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

        Example:

        Shows how to insert a field into a document by FieldCode.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a simple Date field into the document
        // When we insert a field through the DocumentBuilder class we can get the
        // special Field object which contains information about the field
        Field dateField = builder.insertField("DATE \\* MERGEFORMAT");
        
        // Update this particular field in the document so we can get the FieldResult
        dateField.update();
        
        // Display some information from this field
        // The field result is where the last evaluated value is stored. This is what is displayed in the document
        // When field codes are not showing
        Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult());
        
        // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9
        Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());
        
        // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" 
        Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());
        
        // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object
        dateField.remove();
      • getYomi/setYomi

        public java.lang.String getYomi() / public void setYomi(java.lang.String value)
        
        Gets or sets the yomi (first phonetic character for sorting indexes) for the index entry

        Example:

        Shows how to sort INDEX field entries phonetically.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Create an INDEX field which will display the page locations of XE fields in the document body
        FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);
        
        // Set the INDEX table to sort entries phonetically using Hiragana
        index.setUseYomi(doSortEntriesUsingYomi);
        
        if (doSortEntriesUsingYomi)
            Assert.assertEquals(" INDEX  \\y", index.getFieldCode());
        else
            Assert.assertEquals(" INDEX ", index.getFieldCode());
        
        // Insert 4 XE fields, which would show up as entries in the INDEX field's table of contents,
        // sorted in lexicographic order on their "Text" attribute
        builder.insertBreak(BreakType.PAGE_BREAK);
        FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("愛子");
        
        // The "Text" attrubute may contain a word's spelling in Kanji, whose pronounciation may be ambiguous,
        // while a "Yomi" version of the word will be spelled exactly how it is pronounced using Hiragana
        // If our INDEX field is set to use Yomi, then we can sort phonetically using the "Yomi" attribute values instead of the "Text" attribute
        indexEntry.setYomi("あ");
        
        Assert.assertEquals(" XE  愛子 \\y あ", indexEntry.getFieldCode());
        
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("明美");
        indexEntry.setYomi("あ");
        
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("恵美");
        indexEntry.setYomi("え");
        
        builder.insertBreak(BreakType.PAGE_BREAK);
        indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
        indexEntry.setText("愛美");
        indexEntry.setYomi("え");
        
        doc.updateFields();
        doc.save(getArtifactsDir() + "Field.INDEX.XE.Yomi.docx");
    • 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:

        Shows how to insert a field into a document by FieldCode.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a simple Date field into the document
        // When we insert a field through the DocumentBuilder class we can get the
        // special Field object which contains information about the field
        Field dateField = builder.insertField("DATE \\* MERGEFORMAT");
        
        // Update this particular field in the document so we can get the FieldResult
        dateField.update();
        
        // Display some information from this field
        // The field result is where the last evaluated value is stored. This is what is displayed in the document
        // When field codes are not showing
        Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult());
        
        // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9
        Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());
        
        // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" 
        Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());
        
        // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object
        dateField.remove();

        Example:

        Shows how to get text between field start and field separator (or field end if there is no separator).
        // Open a document which contains a MERGEFIELD inside an IF field
        Document doc = new Document(getMyDir() + "Nested fields.docx");
        
        // Get the outer IF field and print its full field code
        FieldIf fieldIf = (FieldIf) doc.getRange().getFields().get(0);
        System.out.println("Full field code including child fields:\n\t{fieldIf.GetFieldCode()}");
        
        // All inner nested fields are printed by default
        Assert.assertEquals(fieldIf.getFieldCode(), fieldIf.getFieldCode(true));
        
        // Print the field code again but this time without the inner MERGEFIELD
        System.out.println("Field code with nested fields omitted:\n\t{fieldIf.GetFieldCode(false)}");
      • getFieldCode

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

        Example:

        Shows how to get text between field start and field separator (or field end if there is no separator).
        // Open a document which contains a MERGEFIELD inside an IF field
        Document doc = new Document(getMyDir() + "Nested fields.docx");
        
        // Get the outer IF field and print its full field code
        FieldIf fieldIf = (FieldIf) doc.getRange().getFields().get(0);
        System.out.println("Full field code including child fields:\n\t{fieldIf.GetFieldCode()}");
        
        // All inner nested fields are printed by default
        Assert.assertEquals(fieldIf.getFieldCode(), fieldIf.getFieldCode(true));
        
        // Print the field code again but this time without the inner MERGEFIELD
        System.out.println("Field code with nested fields omitted:\n\t{fieldIf.GetFieldCode(false)}");
      • remove

        public Node remove()
                   throws java.lang.Exception
        Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.

        Example:

        Shows how to work with a document's field collection.
        public void fieldCollection() throws Exception {
            // Create a new document and insert some fields
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
            builder.insertField(" TIME ");
            builder.insertField(" REVNUM ");
            builder.insertField(" AUTHOR  \"John Doe\" ");
            builder.insertField(" SUBJECT \"My Subject\" ");
            builder.insertField(" QUOTE \"Hello world!\" ");
            doc.updateFields();
        
            // Get the collection that contains all the fields in a document
            FieldCollection fields = doc.getRange().getFields();
            Assert.assertEquals(fields.getCount(), 6);
        
            // Iterate over the field collection and print contents and type of every field using a custom visitor implementation
            FieldVisitor fieldVisitor = new FieldVisitor();
        
            Iterator<Field> fieldEnumerator = fields.iterator();
        
            while (fieldEnumerator.hasNext()) {
                if (fieldEnumerator.next() != null) {
                    Field currentField = fieldEnumerator.next();
        
                    currentField.getStart().accept(fieldVisitor);
                    if (currentField.getSeparator() != null) {
                        currentField.getSeparator().accept(fieldVisitor);
                    }
                    currentField.getEnd().accept(fieldVisitor);
                } else {
                    System.out.println("There are no fields in the document.");
                }
            }
        
            System.out.println(fieldVisitor.getText());
        
            // Get a field to remove itself
            fields.get(0).remove();
            Assert.assertEquals(fields.getCount(), 5);
        
            // Remove a field by reference
            Field lastField = fields.get(3);
            fields.remove(lastField);
            Assert.assertEquals(fields.getCount(), 4);
        
            // Remove a field by index
            fields.removeAt(2);
            Assert.assertEquals(fields.getCount(), 3);
        
            // Remove all fields from the document
            fields.clear();
            Assert.assertEquals(fields.getCount(), 0);
        }
        
        /// <summary>
        /// Document visitor implementation that prints field info.
        /// </summary>
        public static class FieldVisitor extends DocumentVisitor {
            public FieldVisitor() {
                mBuilder = new StringBuilder();
            }
        
            /// <summary>
            /// Gets the plain text of the document that was accumulated by the visitor.
            /// </summary>
            public String getText() {
                return mBuilder.toString();
            }
        
            /// <summary>
            /// Called when a FieldStart node is encountered in the document.
            /// </summary>
            public int visitFieldStart(final FieldStart fieldStart) {
                mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n");
                mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n");
                mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a FieldSeparator node is encountered in the document.
            /// </summary>
            public int visitFieldSeparator(final FieldSeparator fieldSeparator) {
                mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            /// <summary>
            /// Called when a FieldEnd node is encountered in the document.
            /// </summary>
            public int visitFieldEnd(final FieldEnd fieldEnd) {
                mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n");
        
                return VisitorAction.CONTINUE;
            }
        
            private StringBuilder mBuilder;
        }

        Example:

        Shows how to insert a field into a document by FieldCode.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a simple Date field into the document
        // When we insert a field through the DocumentBuilder class we can get the
        // special Field object which contains information about the field
        Field dateField = builder.insertField("DATE \\* MERGEFORMAT");
        
        // Update this particular field in the document so we can get the FieldResult
        dateField.update();
        
        // Display some information from this field
        // The field result is where the last evaluated value is stored. This is what is displayed in the document
        // When field codes are not showing
        Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult());
        
        // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9
        Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());
        
        // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" 
        Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());
        
        // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object
        dateField.remove();
      • unlink

        public boolean unlink()
                      throws java.lang.Exception
        Performs the field unlink.

        Replaces the field with its most recent result.

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

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

        Example:

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

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

        Example:

        Shows how to insert a field into a document by FieldCode.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert a simple Date field into the document
        // When we insert a field through the DocumentBuilder class we can get the
        // special Field object which contains information about the field
        Field dateField = builder.insertField("DATE \\* MERGEFORMAT");
        
        // Update this particular field in the document so we can get the FieldResult
        dateField.update();
        
        // Display some information from this field
        // The field result is where the last evaluated value is stored. This is what is displayed in the document
        // When field codes are not showing
        Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult());
        
        // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9
        Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());
        
        // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" 
        Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());
        
        // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object
        dateField.remove();
      • update

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

        Example:

        Shows a way to update a field ignoring the MERGEFORMAT switch.
        LoadOptions loadOptions = new LoadOptions();
        {
            loadOptions.setPreserveIncludePictureField(true);
        }
        Document doc = new Document(getMyDir() + "Field sample - INCLUDEPICTURE.docx", loadOptions);
        
        for (Field field : doc.getRange().getFields()) {
            if (((field.getType()) == (FieldType.FIELD_INCLUDE_PICTURE))) {
                FieldIncludePicture includePicture = (FieldIncludePicture) field;
                includePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");
                includePicture.update(true);
        
                doc.updateFields();
                doc.save(getArtifactsDir() + "Field.UpdateFieldIgnoringMergeFormat.docx");