java.lang.ObjectField
com.aspose.words.FieldTA
public class FieldTA
Example:
public void fieldTOA() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a TOA field, which will list all the TA entries in the document,
// displaying long citations and page numbers for each
FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false);
// Set the entry category for our table
// For a TA field to be included in this table, it will have to have a matching entry category
fieldToa.setEntryCategory("1");
// Moreover, the Table of Authorities category at index 1 is "Cases",
// which will show up as the title of our table if we set this variable to true
fieldToa.setUseHeading(true);
// We can further filter TA fields by designating a named bookmark that they have to be inside of
fieldToa.setBookmarkName("MyBookmark");
// By default, a dotted line page-wide tab appears between the TA field's citation and its page number
// We can replace it with any text we put in this attribute, even preserving the tab if we use tab character
fieldToa.setEntrySeparator(" \t p.");
// If we have multiple TA entries that share the same long citation,
// all their respective page numbers will show up on one row,
// and the page numbers separated by a string specified here
fieldToa.setPageNumberListSeparator(" & p. ");
// To reduce clutter, we can set this to true to get our table to display the word "passim"
// if there would be 5 or more page numbers in one row
fieldToa.setUsePassim(true);
// One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers
fieldToa.setPageRangeSeparator(" to ");
// The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable
fieldToa.setRemoveEntryFormatting(true);
builder.getFont().setColor(Color.GREEN);
builder.getFont().setName("Arial Black");
Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f");
builder.insertBreak(BreakType.PAGE_BREAK);
// We will insert a TA entry using a document builder
// This entry is outside the bookmark specified by our table, so it won't be displayed
FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1");
Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\"");
// This entry is inside the bookmark,
// but the entry category doesn't match that of the table, so it will also be omitted
builder.startBookmark("MyBookmark");
fieldTA = insertToaEntry(builder, "2", "Source 2");
// This entry will appear in the table
fieldTA = insertToaEntry(builder, "1", "Source 3");
// Short citations aren't displayed by a TOA table,
// but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference
fieldTA.setShortCitation("S.3");
Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3");
// The page number can be made to appear bold and/or italic
// This will still be displayed if our table is set to ignore formatting
fieldTA = insertToaEntry(builder, "1", "Source 2");
fieldTA.isBold(true);
fieldTA.isItalic(true);
Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i");
// We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on
// Note that this entry refers to the same source as the one above, so they will share one row in our table,
// displaying the page number of the entry above as well as the page range of this entry,
// with the table's page list and page number range separators between page numbers
fieldTA = insertToaEntry(builder, "1", "Source 3");
fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark");
builder.startBookmark("MyMultiPageBookmark");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.insertBreak(BreakType.PAGE_BREAK);
builder.insertBreak(BreakType.PAGE_BREAK);
builder.endBookmark("MyMultiPageBookmark");
Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark");
// Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it
for (int i = 0; i < 5; i++) {
insertToaEntry(builder, "1", "Source 4");
}
builder.endBookmark("MyBookmark");
doc.updateFields();
doc.save(getArtifactsDir() + "Field.TOA.TA.docx");
}
/// <summary>
/// Get a builder to insert a TA field, specifying its long citation and category,
/// then insert a page break and return the field we created.
/// </summary>
private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception {
FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false);
field.setEntryCategory(entryCategory);
field.setLongCitation(longCitation);
builder.insertBreak(BreakType.PAGE_BREAK);
return field;
}
Constructor Summary |
---|
FieldTA()
|
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getDisplayResult() | → inherited from Field |
Gets the text that represents the displayed field result. | ||
FieldEnd | getEnd() | → inherited from Field |
Gets the node that represents the field end. | ||
java.lang.String | getEntryCategory() | |
void | setEntryCategory(java.lang.String value) | |
Gets or sets the integral entry category, which is a number that corresponds to the order of categories. | ||
FieldFormat | getFormat() | → inherited from Field |
Gets a |
||
boolean | isBold() | |
void | isBold(boolean value) | |
Gets or sets whether to apply bold formatting to the page number for the entry. | ||
boolean | isDirty() | → inherited from Field |
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. | ||
boolean | isItalic() | |
void | isItalic(boolean value) | |
Gets or sets whether to apply italic formatting to the page number for the entry. | ||
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
Gets or sets whether the field is locked (should not recalculate its result). | ||
int | getLocaleId() | → inherited from Field |
void | setLocaleId(int value) | |
Gets or sets the LCID of the field. | ||
java.lang.String | getLongCitation() | |
void | setLongCitation(java.lang.String value) | |
Gets or sets the long citation for the entry. | ||
java.lang.String | getPageRangeBookmarkName() | |
void | setPageRangeBookmarkName(java.lang.String value) | |
Gets or sets the name of the bookmark that marks a range of pages that is inserted as the entry's page number. | ||
java.lang.String | getResult() | → inherited from Field |
void | setResult(java.lang.String value) | |
Gets or sets text that is between the field separator and field end. | ||
FieldSeparator | getSeparator() | → inherited from Field |
Gets the node that represents the field separator. Can be null. | ||
java.lang.String | getShortCitation() | |
void | setShortCitation(java.lang.String value) | |
Gets or sets the short citation for the entry. | ||
FieldStart | getStart() | → inherited from Field |
Gets the node that represents the start of the field. | ||
int | getType() | → inherited from Field |
Gets the Microsoft Word field type. The value of the property is FieldType integer constant. |
Method Summary | ||
---|---|---|
java.lang.String | getFieldCode() | → 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.String | getFieldCode(boolean includeChildFieldCodes) | → inherited from Field |
Returns text between field start and field separator (or field end if there is no separator). | ||
Node | remove() | → 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. | ||
boolean | unlink() | → inherited from Field |
Performs the field unlink. | ||
void | update() | → inherited from Field |
Performs the field update. Throws if the field is being updated already. | ||
void | update(boolean ignoreMergeFormat) | → inherited from Field |
Performs a field update. Throws if the field is being updated already. |
Constructor Detail |
---|
public FieldTA()
Property Getters/Setters Detail |
---|
getDisplayResult | → inherited from Field |
public java.lang.String getDisplayResult() |
Example:
Shows how to get the text that represents the displayed field result.Document document = new Document(getMyDir() + "Various fields.docx"); FieldCollection fields = document.getRange().getFields(); Assert.assertEquals(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() |
Example:
Shows how to work with a document's field collection.public void fieldCollection() throws Exception { // Create a new document and insert some fields Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" "); builder.insertField(" TIME "); builder.insertField(" REVNUM "); builder.insertField(" AUTHOR \"John Doe\" "); builder.insertField(" SUBJECT \"My Subject\" "); builder.insertField(" QUOTE \"Hello world!\" "); doc.updateFields(); // Get the collection that contains all the fields in a document FieldCollection fields = doc.getRange().getFields(); Assert.assertEquals(fields.getCount(), 6); // Iterate over the field collection and print contents and type of every field using a custom visitor implementation FieldVisitor fieldVisitor = new FieldVisitor(); Iterator<Field> fieldEnumerator = fields.iterator(); while (fieldEnumerator.hasNext()) { if (fieldEnumerator.next() != null) { Field currentField = fieldEnumerator.next(); currentField.getStart().accept(fieldVisitor); if (currentField.getSeparator() != null) { currentField.getSeparator().accept(fieldVisitor); } currentField.getEnd().accept(fieldVisitor); } else { System.out.println("There are no fields in the document."); } } System.out.println(fieldVisitor.getText()); // Get a field to remove itself fields.get(0).remove(); Assert.assertEquals(fields.getCount(), 5); // Remove a field by reference Field lastField = fields.get(3); fields.remove(lastField); Assert.assertEquals(fields.getCount(), 4); // Remove a field by index fields.removeAt(2); Assert.assertEquals(fields.getCount(), 3); // Remove all fields from the document fields.clear(); Assert.assertEquals(fields.getCount(), 0); } /// <summary> /// Document visitor implementation that prints field info. /// </summary> public static class FieldVisitor extends DocumentVisitor { public FieldVisitor() { mBuilder = new StringBuilder(); } /// <summary> /// Gets the plain text of the document that was accumulated by the visitor. /// </summary> public String getText() { return mBuilder.toString(); } /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public int visitFieldStart(final FieldStart fieldStart) { mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n"); mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n"); mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public int visitFieldSeparator(final FieldSeparator fieldSeparator) { mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public int visitFieldEnd(final FieldEnd fieldEnd) { mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; }
getEntryCategory/setEntryCategory | |
public java.lang.String getEntryCategory() / public void setEntryCategory(java.lang.String value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getFormat | → inherited from Field |
public FieldFormat getFormat() |
Example:
Shows how to format fields.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Use a document builder to insert field with no format Field field = builder.insertField("= 2 + 3"); // We can format our field here instead of in the field code FieldFormat format = field.getFormat(); format.setNumericFormat("$###.00"); field.update(); // 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");
isBold/isBold | |
public boolean isBold() / public void isBold(boolean value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
isDirty/isDirty | → inherited from Field |
public boolean isDirty() / public void isDirty(boolean value) |
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); doc.save(getArtifactsDir() + "Field.insertAndUpdateDirtyField.docx"); Assert.assertTrue(doc.getRange().getFields().get(0).isDirty()); LoadOptions loadOptions = new LoadOptions(); loadOptions.setUpdateDirtyFields(false); doc = new Document(getArtifactsDir() + "Field.insertAndUpdateDirtyField.docx", loadOptions);
isItalic/isItalic | |
public boolean isItalic() / public void isItalic(boolean value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value) |
Example:
Demonstrates how to retrieve the field class from an existing FieldStart node in the document.Document doc = new Document(getMyDir() + "Table of contents.docx"); FieldChar fieldStart = (FieldChar) doc.getChild(NodeType.FIELD_START, 0, true); Assert.assertEquals(fieldStart.getFieldType(), FieldType.FIELD_TOC); Assert.assertEquals(fieldStart.isDirty(), false); Assert.assertEquals(fieldStart.isLocked(), false); // Retrieve the facade object which represents the field in the document Field field = fieldStart.getField(); Assert.assertEquals(field.isLocked(), false); Assert.assertEquals(field.getFieldCode(), " TOC \\o \"1-3\" \\h \\z \\u "); // This updates only this field in the document field.update();
getLocaleId/setLocaleId | → inherited from Field |
public int getLocaleId() / public void setLocaleId(int value) |
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);
getLongCitation/setLongCitation | |
public java.lang.String getLongCitation() / public void setLongCitation(java.lang.String value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getPageRangeBookmarkName/setPageRangeBookmarkName | |
public java.lang.String getPageRangeBookmarkName() / public void setPageRangeBookmarkName(java.lang.String value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getResult/setResult | → inherited from Field |
public java.lang.String getResult() / public void setResult(java.lang.String value) |
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 behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9 System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object dateField.remove();
getSeparator | → inherited from Field |
public FieldSeparator getSeparator() |
Example:
Shows how to work with a document's field collection.public void fieldCollection() throws Exception { // Create a new document and insert some fields Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" "); builder.insertField(" TIME "); builder.insertField(" REVNUM "); builder.insertField(" AUTHOR \"John Doe\" "); builder.insertField(" SUBJECT \"My Subject\" "); builder.insertField(" QUOTE \"Hello world!\" "); doc.updateFields(); // Get the collection that contains all the fields in a document FieldCollection fields = doc.getRange().getFields(); Assert.assertEquals(fields.getCount(), 6); // Iterate over the field collection and print contents and type of every field using a custom visitor implementation FieldVisitor fieldVisitor = new FieldVisitor(); Iterator<Field> fieldEnumerator = fields.iterator(); while (fieldEnumerator.hasNext()) { if (fieldEnumerator.next() != null) { Field currentField = fieldEnumerator.next(); currentField.getStart().accept(fieldVisitor); if (currentField.getSeparator() != null) { currentField.getSeparator().accept(fieldVisitor); } currentField.getEnd().accept(fieldVisitor); } else { System.out.println("There are no fields in the document."); } } System.out.println(fieldVisitor.getText()); // Get a field to remove itself fields.get(0).remove(); Assert.assertEquals(fields.getCount(), 5); // Remove a field by reference Field lastField = fields.get(3); fields.remove(lastField); Assert.assertEquals(fields.getCount(), 4); // Remove a field by index fields.removeAt(2); Assert.assertEquals(fields.getCount(), 3); // Remove all fields from the document fields.clear(); Assert.assertEquals(fields.getCount(), 0); } /// <summary> /// Document visitor implementation that prints field info. /// </summary> public static class FieldVisitor extends DocumentVisitor { public FieldVisitor() { mBuilder = new StringBuilder(); } /// <summary> /// Gets the plain text of the document that was accumulated by the visitor. /// </summary> public String getText() { return mBuilder.toString(); } /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public int visitFieldStart(final FieldStart fieldStart) { mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n"); mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n"); mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public int visitFieldSeparator(final FieldSeparator fieldSeparator) { mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public int visitFieldEnd(final FieldEnd fieldEnd) { mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; }
getShortCitation/setShortCitation | |
public java.lang.String getShortCitation() / public void setShortCitation(java.lang.String value) |
Example:
Shows how to build and customize a table of authorities using TOA and TA fields.public void fieldTOA() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOA field, which will list all the TA entries in the document, // displaying long citations and page numbers for each FieldToa fieldToa = (FieldToa) builder.insertField(FieldType.FIELD_TOA, false); // Set the entry category for our table // For a TA field to be included in this table, it will have to have a matching entry category fieldToa.setEntryCategory("1"); // Moreover, the Table of Authorities category at index 1 is "Cases", // which will show up as the title of our table if we set this variable to true fieldToa.setUseHeading(true); // We can further filter TA fields by designating a named bookmark that they have to be inside of fieldToa.setBookmarkName("MyBookmark"); // By default, a dotted line page-wide tab appears between the TA field's citation and its page number // We can replace it with any text we put in this attribute, even preserving the tab if we use tab character fieldToa.setEntrySeparator(" \t p."); // If we have multiple TA entries that share the same long citation, // all their respective page numbers will show up on one row, // and the page numbers separated by a string specified here fieldToa.setPageNumberListSeparator(" & p. "); // To reduce clutter, we can set this to true to get our table to display the word "passim" // if there would be 5 or more page numbers in one row fieldToa.setUsePassim(true); // One TA field can refer to a range of pages, and the sequence specified here will be between the start and end page numbers fieldToa.setPageRangeSeparator(" to "); // The format from the TA fields will carry over into our table, and we can stop it from doing so by setting this variable fieldToa.setRemoveEntryFormatting(true); builder.getFont().setColor(Color.GREEN); builder.getFont().setName("Arial Black"); Assert.assertEquals(fieldToa.getFieldCode(), " TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"); builder.insertBreak(BreakType.PAGE_BREAK); // We will insert a TA entry using a document builder // This entry is outside the bookmark specified by our table, so it won't be displayed FieldTA fieldTA = insertToaEntry(builder, "1", "Source 1"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 1\""); // This entry is inside the bookmark, // but the entry category doesn't match that of the table, so it will also be omitted builder.startBookmark("MyBookmark"); fieldTA = insertToaEntry(builder, "2", "Source 2"); // This entry will appear in the table fieldTA = insertToaEntry(builder, "1", "Source 3"); // Short citations aren't displayed by a TOA table, // but they can be used as a shorthand to refer to bulky source names that multiple TA fields reference fieldTA.setShortCitation("S.3"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\s S.3"); // The page number can be made to appear bold and/or italic // This will still be displayed if our table is set to ignore formatting fieldTA = insertToaEntry(builder, "1", "Source 2"); fieldTA.isBold(true); fieldTA.isItalic(true); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 2\" \\b \\i"); // We can get TA fields to refer to a range of pages that a bookmark spans across instead of the page that they are on // Note that this entry refers to the same source as the one above, so they will share one row in our table, // displaying the page number of the entry above as well as the page range of this entry, // with the table's page list and page number range separators between page numbers fieldTA = insertToaEntry(builder, "1", "Source 3"); fieldTA.setPageRangeBookmarkName("MyMultiPageBookmark"); builder.startBookmark("MyMultiPageBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.insertBreak(BreakType.PAGE_BREAK); builder.endBookmark("MyMultiPageBookmark"); Assert.assertEquals(fieldTA.getFieldCode(), " TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"); // Having 5 or more TA entries with the same source invokes the "passim" feature of our table, if we enabled it for (int i = 0; i < 5; i++) { insertToaEntry(builder, "1", "Source 4"); } builder.endBookmark("MyBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOA.TA.docx"); } /// <summary> /// Get a builder to insert a TA field, specifying its long citation and category, /// then insert a page break and return the field we created. /// </summary> private FieldTA insertToaEntry(final DocumentBuilder builder, final String entryCategory, final String longCitation) throws Exception { FieldTA field = (FieldTA) builder.insertField(FieldType.FIELD_TOA_ENTRY, false); field.setEntryCategory(entryCategory); field.setLongCitation(longCitation); builder.insertBreak(BreakType.PAGE_BREAK); return field; }
getStart | → inherited from Field |
public FieldStart getStart() |
Example:
Shows how to work with a document's field collection.public void fieldCollection() throws Exception { // Create a new document and insert some fields Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" "); builder.insertField(" TIME "); builder.insertField(" REVNUM "); builder.insertField(" AUTHOR \"John Doe\" "); builder.insertField(" SUBJECT \"My Subject\" "); builder.insertField(" QUOTE \"Hello world!\" "); doc.updateFields(); // Get the collection that contains all the fields in a document FieldCollection fields = doc.getRange().getFields(); Assert.assertEquals(fields.getCount(), 6); // Iterate over the field collection and print contents and type of every field using a custom visitor implementation FieldVisitor fieldVisitor = new FieldVisitor(); Iterator<Field> fieldEnumerator = fields.iterator(); while (fieldEnumerator.hasNext()) { if (fieldEnumerator.next() != null) { Field currentField = fieldEnumerator.next(); currentField.getStart().accept(fieldVisitor); if (currentField.getSeparator() != null) { currentField.getSeparator().accept(fieldVisitor); } currentField.getEnd().accept(fieldVisitor); } else { System.out.println("There are no fields in the document."); } } System.out.println(fieldVisitor.getText()); // Get a field to remove itself fields.get(0).remove(); Assert.assertEquals(fields.getCount(), 5); // Remove a field by reference Field lastField = fields.get(3); fields.remove(lastField); Assert.assertEquals(fields.getCount(), 4); // Remove a field by index fields.removeAt(2); Assert.assertEquals(fields.getCount(), 3); // Remove all fields from the document fields.clear(); Assert.assertEquals(fields.getCount(), 0); } /// <summary> /// Document visitor implementation that prints field info. /// </summary> public static class FieldVisitor extends DocumentVisitor { public FieldVisitor() { mBuilder = new StringBuilder(); } /// <summary> /// Gets the plain text of the document that was accumulated by the visitor. /// </summary> public String getText() { return mBuilder.toString(); } /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public int visitFieldStart(final FieldStart fieldStart) { mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n"); mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n"); mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public int visitFieldSeparator(final FieldSeparator fieldSeparator) { mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public int visitFieldEnd(final FieldEnd fieldEnd) { mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; }
getType | → inherited from Field |
public int getType() |
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 behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9 System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object dateField.remove();
Method Detail |
---|
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode() |
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 behavior 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() + "Nested fields.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) |
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() + "Nested fields.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 |
Example:
Shows how to work with a document's field collection.public void fieldCollection() throws Exception { // Create a new document and insert some fields Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" "); builder.insertField(" TIME "); builder.insertField(" REVNUM "); builder.insertField(" AUTHOR \"John Doe\" "); builder.insertField(" SUBJECT \"My Subject\" "); builder.insertField(" QUOTE \"Hello world!\" "); doc.updateFields(); // Get the collection that contains all the fields in a document FieldCollection fields = doc.getRange().getFields(); Assert.assertEquals(fields.getCount(), 6); // Iterate over the field collection and print contents and type of every field using a custom visitor implementation FieldVisitor fieldVisitor = new FieldVisitor(); Iterator<Field> fieldEnumerator = fields.iterator(); while (fieldEnumerator.hasNext()) { if (fieldEnumerator.next() != null) { Field currentField = fieldEnumerator.next(); currentField.getStart().accept(fieldVisitor); if (currentField.getSeparator() != null) { currentField.getSeparator().accept(fieldVisitor); } currentField.getEnd().accept(fieldVisitor); } else { System.out.println("There are no fields in the document."); } } System.out.println(fieldVisitor.getText()); // Get a field to remove itself fields.get(0).remove(); Assert.assertEquals(fields.getCount(), 5); // Remove a field by reference Field lastField = fields.get(3); fields.remove(lastField); Assert.assertEquals(fields.getCount(), 4); // Remove a field by index fields.removeAt(2); Assert.assertEquals(fields.getCount(), 3); // Remove all fields from the document fields.clear(); Assert.assertEquals(fields.getCount(), 0); } /// <summary> /// Document visitor implementation that prints field info. /// </summary> public static class FieldVisitor extends DocumentVisitor { public FieldVisitor() { mBuilder = new StringBuilder(); } /// <summary> /// Gets the plain text of the document that was accumulated by the visitor. /// </summary> public String getText() { return mBuilder.toString(); } /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public int visitFieldStart(final FieldStart fieldStart) { mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n"); mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n"); mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public int visitFieldSeparator(final FieldSeparator fieldSeparator) { mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public int visitFieldEnd(final FieldEnd fieldEnd) { mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; }
Example:
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 behavior 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 |
Replaces the field with its most recent result.
Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.
True
if the field has been unlinked, otherwise false
.
Example:
Shows how to unlink specific field.Document doc = new Document(getMyDir() + "Linked fields.docx"); doc.getRange().getFields().get(1).unlink();
update | → inherited from Field |
public void update() throws java.lang.Exception |
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 behavior 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 |
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 INCLUDEPICTURE.docx", loadOptions); for (Field field : doc.getRange().getFields()) { if (((field.getType()) == (FieldType.FIELD_INCLUDE_PICTURE))) { FieldIncludePicture includePicture = (FieldIncludePicture) field; includePicture.setSourceFullName(getImageDir() + "Transparent background logo.png"); includePicture.update(true); } } doc.updateFields(); doc.save(getArtifactsDir() + "Field.UpdateFieldIgnoringMergeFormat.docx");