com.aspose.words
Class FieldIndex

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

public class FieldIndex 
extends Field

Implements the INDEX field. Builds an index using the index entries specified by XE fields, and inserts that index at this place in the document.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

Constructor Summary
FieldIndex()
          
 
Property Getters/Setters Summary
java.lang.StringgetBookmarkName()
voidsetBookmarkName(java.lang.String value)
           Gets or sets the name of the bookmark that marks the portion of the document used to build the index.
java.lang.StringgetCrossReferenceSeparator()
voidsetCrossReferenceSeparator(java.lang.String value)
           Gets or sets the character sequence that is used to separate cross references and other entries.
java.lang.StringgetDisplayResult()→ inherited from Field
           Gets the text that represents the displayed field result.
FieldEndgetEnd()→ inherited from Field
           Gets the node that represents the field end.
java.lang.StringgetEntryType()
voidsetEntryType(java.lang.String value)
           Gets or sets an index entry type used to build the index.
FieldFormatgetFormat()→ inherited from Field
           Gets a FieldFormat object that provides typed access to field's formatting.
booleanhasPageNumberSeparator()
           Gets a value indicating whether a page number separator is overridden through the field's code.
booleanhasSequenceName()
           Gets a value indicating whether a sequence should be used while the field's result building.
java.lang.StringgetHeading()
voidsetHeading(java.lang.String value)
           Gets or sets a heading that appears at the start of each set of entries for any given letter.
booleanisDirty()→ inherited from Field
voidisDirty(boolean value)
           Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
java.lang.StringgetLanguageId()
voidsetLanguageId(java.lang.String value)
           Gets or sets the language ID used to generate the index.
java.lang.StringgetLetterRange()
voidsetLetterRange(java.lang.String value)
           Gets or sets a range of letters to which limit the index.
intgetLocaleId()→ inherited from Field
voidsetLocaleId(int value)
           Gets or sets the LCID of the field.
java.lang.StringgetNumberOfColumns()
voidsetNumberOfColumns(java.lang.String value)
           Gets or sets the number of columns per page used when building the index.
java.lang.StringgetPageNumberListSeparator()
voidsetPageNumberListSeparator(java.lang.String value)
           Gets or sets the character sequence that is used to separate two page numbers in a page number list.
java.lang.StringgetPageNumberSeparator()
voidsetPageNumberSeparator(java.lang.String value)
           Gets or sets the character sequence that is used to separate an index entry and its page number.
java.lang.StringgetPageRangeSeparator()
voidsetPageRangeSeparator(java.lang.String value)
           Gets or sets the character sequence that is used to separate the start and end of a page range.
java.lang.StringgetResult()→ inherited from Field
voidsetResult(java.lang.String value)
           Gets or sets text that is between the field separator and field end.
booleangetRunSubentriesOnSameLine()
voidsetRunSubentriesOnSameLine(boolean value)
           Gets or sets whether run subentries into the same line as the main entry.
FieldSeparatorgetSeparator()→ inherited from Field
           Gets the node that represents the field separator. Can be null.
java.lang.StringgetSequenceName()
voidsetSequenceName(java.lang.String value)
           Gets or sets the name of a sequence whose number is included with the page number.
java.lang.StringgetSequenceSeparator()
voidsetSequenceSeparator(java.lang.String value)
           Gets or sets the character sequence that is used to separate sequence numbers and page numbers.
FieldStartgetStart()→ inherited from Field
           Gets the node that represents the start of the field.
intgetType()→ inherited from Field
           Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
booleangetUseYomi()
voidsetUseYomi(boolean value)
           Gets or sets whether to enable the use of yomi text for index entries.
 
Method Summary
java.lang.StringgetFieldCode()→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
java.lang.StringgetFieldCode(boolean includeChildFieldCodes)→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator).
Noderemove()→ inherited from Field
           Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.
booleanunlink()→ inherited from Field
           Performs the field unlink.
voidupdate()→ inherited from Field
           Performs the field update. Throws if the field is being updated already.
voidupdate(boolean ignoreMergeFormat)→ inherited from Field
           Performs a field update. Throws if the field is being updated already.
 

Constructor Detail

FieldIndex

public FieldIndex()

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 that marks the portion of the document used to build the index.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getCrossReferenceSeparator/setCrossReferenceSeparator

public java.lang.String getCrossReferenceSeparator() / public void setCrossReferenceSeparator(java.lang.String value)
Gets or sets the character sequence that is used to separate cross references and other entries.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getDisplayResult

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

Example:

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

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

Assert.assertEquals(fields.get(0).getDisplayResult(), "111");
Assert.assertEquals(fields.get(1).getDisplayResult(), "222");
Assert.assertEquals(fields.get(2).getDisplayResult(), "Multi\rLine\rText");
Assert.assertEquals(fields.get(3).getDisplayResult(), "%");
Assert.assertEquals(fields.get(4).getDisplayResult(), "Macro Button Text");
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(fields.get(5).getDisplayResult(), "1)");

getEnd

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

Example:

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

getEntryType/setEntryType

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

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getFormat

→ inherited from Field
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");

hasPageNumberSeparator

public boolean hasPageNumberSeparator()
Gets a value indicating whether a page number separator is overridden through the field's code.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

hasSequenceName

public boolean hasSequenceName()
Gets a value indicating whether a sequence should be used while the field's result building.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getHeading/setHeading

public java.lang.String getHeading() / public void setHeading(java.lang.String value)
Gets or sets a heading that appears at the start of each set of entries for any given letter.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

isDirty/isDirty

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

Example:

Shows how to use special property for updating field result
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Field fieldToc = builder.insertTableOfContents("\\o \"1-3\" \\h \\z \\u");
fieldToc.isDirty(true);

isLocked/isLocked

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

Example:

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

getLanguageId/setLanguageId

public java.lang.String getLanguageId() / public void setLanguageId(java.lang.String value)
Gets or sets the language ID used to generate the index.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getLetterRange/setLetterRange

public java.lang.String getLetterRange() / public void setLetterRange(java.lang.String value)
Gets or sets a range of letters to which limit the index.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getLocaleId/setLocaleId

→ inherited from Field
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

getNumberOfColumns/setNumberOfColumns

public java.lang.String getNumberOfColumns() / public void setNumberOfColumns(java.lang.String value)
Gets or sets the number of columns per page used when building the index.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getPageNumberListSeparator/setPageNumberListSeparator

public java.lang.String getPageNumberListSeparator() / public void setPageNumberListSeparator(java.lang.String value)
Gets or sets the character sequence that is used to separate two page numbers in a page number list.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getPageNumberSeparator/setPageNumberSeparator

public java.lang.String getPageNumberSeparator() / public void setPageNumberSeparator(java.lang.String value)
Gets or sets the character sequence that is used to separate an index entry and its page number.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getPageRangeSeparator/setPageRangeSeparator

public java.lang.String getPageRangeSeparator() / public void setPageRangeSeparator(java.lang.String value)
Gets or sets the character sequence that is used to separate the start and end of a page range.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getResult/setResult

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

Example:

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

getRunSubentriesOnSameLine/setRunSubentriesOnSameLine

public boolean getRunSubentriesOnSameLine() / public void setRunSubentriesOnSameLine(boolean value)
Gets or sets whether run subentries into the same line as the main entry.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getSeparator

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

Example:

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

getSequenceName/setSequenceName

public java.lang.String getSequenceName() / public void setSequenceName(java.lang.String value)
Gets or sets the name of a sequence whose number is included with the page number.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getSequenceSeparator/setSequenceSeparator

public java.lang.String getSequenceSeparator() / public void setSequenceSeparator(java.lang.String value)
Gets or sets the character sequence that is used to separate sequence numbers and page numbers.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

getStart

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

Example:

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

→ inherited from Field
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();

getUseYomi/setUseYomi

public boolean getUseYomi() / public void setUseYomi(boolean value)
Gets or sets whether to enable the use of yomi text for index entries.

Example:

Shows how to populate an index field with index entries.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create an index field which will contain all the index entries
FieldIndex index = (FieldIndex) builder.insertField(FieldType.FIELD_INDEX, true);

// Bookmark that will encompass a section that we want to index
String mainBookmarkName = "MainBookmark";
builder.startBookmark(mainBookmarkName);
index.setBookmarkName(mainBookmarkName);
index.setCrossReferenceSeparator(":");
index.setHeading(">");
index.setLanguageId("1033");
index.setLetterRange("a-j");
index.setNumberOfColumns("2");
index.setPageNumberListSeparator("|");
index.setPageNumberSeparator("|");
index.setPageRangeSeparator("/");
index.setUseYomi(true);
index.setRunSubentriesOnSameLine(false);
index.setSequenceName("Chapter");
index.setSequenceSeparator(":");
Assert.assertTrue(index.hasPageNumberSeparator());
Assert.assertTrue(index.hasSequenceName());

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

// Use a document builder to insert an index entry
// Index entries are not added to the index manually, it will find them on its own
FieldXE indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 1");
indexEntry.setEntryType("Type1");
indexEntry.isBold(true);
indexEntry.isItalic(true);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), false);

// We can insert a bookmark and have the index field point to it
String subBookmarkName = "MyBookmark";
builder.startBookmark(subBookmarkName);
builder.writeln("Bookmark text contents.");
builder.endBookmark(subBookmarkName);

// Put the bookmark and index entry field on different pages
// Our index will use the page that the bookmark is on, not that of the index entry field, as the page number
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 2");
indexEntry.setEntryType("Type1");
indexEntry.setPageRangeBookmarkName(subBookmarkName);
Assert.assertEquals(indexEntry.hasPageRangeBookmarkName(), true);

// We can use the PageNumberReplacement property to point to any page we want, even one that may not exist
builder.insertBreak(BreakType.PAGE_BREAK);
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("Index entry 3");
indexEntry.setEntryType("Type1");
indexEntry.setPageNumberReplacement("999");

// If we are using an East Asian language, we can sort entries phonetically (using Furigana) instead of alphabetically
indexEntry = (FieldXE) builder.insertField(FieldType.FIELD_INDEX_ENTRY, true);
indexEntry.setText("漢字");
indexEntry.setEntryType("Type1");

// The Yomi field will contain the character looked up for sorting
indexEntry.setYomi("か");

// If we are sorting phonetically, we need to notify the index
index.setUseYomi(true);

// For all our entry fields, we set the entry type to "Type1"
// Our field index will not list those entries unless we set its entry type to that of the entries
index.setEntryType("Type1");

builder.endBookmark(mainBookmarkName);

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

Method Detail

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode()
Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.

Example:

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

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

Example:

Shows how to get text between field start and field separator (or field end if there is no separator)
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

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

Example:

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

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

Replaces the field with its most recent result.

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

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

Example:

Shows how to unlink specific field
Document doc = new Document(getMyDir() + "Field.UnlinkFields.docx");

doc.getRange().getFields().get(1).unlink();

update

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

Example:

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

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

Example:

Shows a way to update a field ignoring the MERGEFORMAT switch
LoadOptions loadOptions = new LoadOptions();
loadOptions.setPreserveIncludePictureField(true);

Document doc = new Document(getMyDir() + "Field.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");

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