java.lang.ObjectField
com.aspose.words.FieldRef
public class FieldRef
Example:
public void fieldRef() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert the bookmark that all our REF fields will reference and leave it at the end of the document
builder.startBookmark("MyBookmark");
builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #1");
builder.write("Text that will appear in REF field");
builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #2");
builder.endBookmark("MyBookmark");
builder.moveToDocumentStart();
// We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at
// Note that the angle brackets count as non-delimiter characters
builder.getListFormat().applyNumberDefault();
builder.getListFormat().getListLevel().setNumberFormat("> \u0000");
// Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes
FieldRef field = insertFieldRef(builder, "MyBookmark", "", "\n");
field.setIncludeNoteOrComment(true);
field.setInsertHyperlink(true);
Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\f \\h");
// Insert a REF field and display whether the referenced bookmark is above or below it
field = insertFieldRef(builder, "MyBookmark", "The referenced paragraph is ", " this field.\n");
field.setInsertRelativePosition(true);
Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\p");
// Display the list number of the bookmark, as it appears in the document
field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number is ", "\n");
field.setInsertParagraphNumber(true);
Assert.assertEquals(" REF MyBookmark \\n", field.getFieldCode());
// Display the list number of the bookmark, but with non-delimiter characters omitted
// In this case they are the angle brackets
field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number, non-delimiters suppressed, is ", "\n");
field.setInsertParagraphNumber(true);
field.setSuppressNonDelimiters(true);
Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\n \\t");
// Move down one list level
builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/;
builder.getListFormat().getListLevel().setNumberFormat(">> \u0001");
// Display the list number of the bookmark as well as the numbers of all the list levels above it
field = insertFieldRef(builder, "MyBookmark", "The bookmark's full context paragraph number is ", "\n");
field.setInsertParagraphNumberInFullContext(true);
Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\w");
builder.insertBreak(BreakType.PAGE_BREAK);
// Display the list level numbers between this REF field and the bookmark that it is referencing
field = insertFieldRef(builder, "MyBookmark", "The bookmark's relative paragraph number is ", "\n");
field.setInsertParagraphNumberInRelativeContext(true);
Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\r");
// The bookmark, which is at the end of the document, will show up as a list item here
builder.writeln("List level above bookmark");
builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/;
builder.getListFormat().getListLevel().setNumberFormat(">>> \u0002");
doc.updateFields();
doc.save(getArtifactsDir() + "Field.Ref.docx");
}
/// <summary>
/// Get the document builder to insert a REF field, reference a bookmark with it, and add text before and after
/// </summary>
private FieldRef insertFieldRef(final DocumentBuilder builder, final String bookmarkName,
final String textBefore, final String textAfter) throws Exception {
builder.write(textBefore);
FieldRef field = (FieldRef) builder.insertField(FieldType.FIELD_REF, true);
field.setBookmarkName(bookmarkName);
builder.write(textAfter);
return field;
}
Constructor Summary |
---|
FieldRef()
|
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getBookmarkName() | |
void | setBookmarkName(java.lang.String value) | |
Gets or sets the referenced bookmark's name. | ||
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. | ||
FieldFormat | getFormat() | → inherited from Field |
Gets a |
||
boolean | getIncludeNoteOrComment() | |
void | setIncludeNoteOrComment(boolean value) | |
Gets or sets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text. | ||
boolean | getInsertHyperlink() | |
void | setInsertHyperlink(boolean value) | |
Gets or sets whether to create a hyperlink to the bookmarked paragraph. | ||
boolean | getInsertParagraphNumber() | |
void | setInsertParagraphNumber(boolean value) | |
Gets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document. | ||
boolean | getInsertParagraphNumberInFullContext() | |
void | setInsertParagraphNumberInFullContext(boolean value) | |
Gets or sets whether to insert the paragraph number of the referenced paragraph in full context. | ||
boolean | getInsertParagraphNumberInRelativeContext() | |
void | setInsertParagraphNumberInRelativeContext(boolean value) | |
Gets or sets whether to insert the paragraph number of the referenced paragraph in relative context. | ||
boolean | getInsertRelativePosition() | |
void | setInsertRelativePosition(boolean value) | |
Gets or sets whether to insert the relative position of the referenced paragraph. | ||
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 | 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 | getNumberSeparator() | |
void | setNumberSeparator(java.lang.String value) | |
Gets or sets the character sequence that is used to separate sequence numbers and page numbers. | ||
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. | ||
FieldStart | getStart() | → inherited from Field |
Gets the node that represents the start of the field. | ||
boolean | getSuppressNonDelimiters() | |
void | setSuppressNonDelimiters(boolean value) | |
Gets or sets whether to suppress non-delimiter characters. | ||
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 FieldRef()
Property Getters/Setters Detail |
---|
getBookmarkName/setBookmarkName | |
public java.lang.String getBookmarkName() / public void setBookmarkName(java.lang.String value) |
Example:
Shows how to insert REF fields to reference bookmarks and present them in various ways.public void fieldRef() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert the bookmark that all our REF fields will reference and leave it at the end of the document builder.startBookmark("MyBookmark"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #1"); builder.write("Text that will appear in REF field"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #2"); builder.endBookmark("MyBookmark"); builder.moveToDocumentStart(); // We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at // Note that the angle brackets count as non-delimiter characters builder.getListFormat().applyNumberDefault(); builder.getListFormat().getListLevel().setNumberFormat("> \u0000"); // Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes FieldRef field = insertFieldRef(builder, "MyBookmark", "", "\n"); field.setIncludeNoteOrComment(true); field.setInsertHyperlink(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\f \\h"); // Insert a REF field and display whether the referenced bookmark is above or below it field = insertFieldRef(builder, "MyBookmark", "The referenced paragraph is ", " this field.\n"); field.setInsertRelativePosition(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\p"); // Display the list number of the bookmark, as it appears in the document field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number is ", "\n"); field.setInsertParagraphNumber(true); Assert.assertEquals(" REF MyBookmark \\n", field.getFieldCode()); // Display the list number of the bookmark, but with non-delimiter characters omitted // In this case they are the angle brackets field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number, non-delimiters suppressed, is ", "\n"); field.setInsertParagraphNumber(true); field.setSuppressNonDelimiters(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\n \\t"); // Move down one list level builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">> \u0001"); // Display the list number of the bookmark as well as the numbers of all the list levels above it field = insertFieldRef(builder, "MyBookmark", "The bookmark's full context paragraph number is ", "\n"); field.setInsertParagraphNumberInFullContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\w"); builder.insertBreak(BreakType.PAGE_BREAK); // Display the list level numbers between this REF field and the bookmark that it is referencing field = insertFieldRef(builder, "MyBookmark", "The bookmark's relative paragraph number is ", "\n"); field.setInsertParagraphNumberInRelativeContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\r"); // The bookmark, which is at the end of the document, will show up as a list item here builder.writeln("List level above bookmark"); builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">>> \u0002"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.Ref.docx"); } /// <summary> /// Get the document builder to insert a REF field, reference a bookmark with it, and add text before and after /// </summary> private FieldRef insertFieldRef(final DocumentBuilder builder, final String bookmarkName, final String textBefore, final String textAfter) throws Exception { builder.write(textBefore); FieldRef field = (FieldRef) builder.insertField(FieldType.FIELD_REF, true); field.setBookmarkName(bookmarkName); builder.write(textAfter); return field; }
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() + "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() |
Example:
Shows how to work with a document's field collection.public void fieldCollection() throws Exception { // Open a document that has fields Document doc = new Document(getMyDir() + "Document.ContainsFields.docx"); // Get the collection that contains all the fields in a document FieldCollection fields = doc.getRange().getFields(); Assert.assertEquals(fields.getCount(), 6); // Iterate over the field collection and print contents and type of every field using a custom visitor implementation FieldVisitor fieldVisitor = new FieldVisitor(); Iterator<Field> fieldEnumerator = fields.iterator(); while (fieldEnumerator.hasNext()) { if (fieldEnumerator.next() != null) { Field currentField = fieldEnumerator.next(); currentField.getStart().accept(fieldVisitor); if (currentField.getSeparator() != null) { currentField.getSeparator().accept(fieldVisitor); } currentField.getEnd().accept(fieldVisitor); } else { System.out.println("There are no fields in the document."); } } System.out.println(fieldVisitor.getText()); // Get a field to remove itself fields.get(0).remove(); Assert.assertEquals(fields.getCount(), 5); // Remove a field by reference Field lastField = fields.get(3); fields.remove(lastField); Assert.assertEquals(fields.getCount(), 4); // Remove a field by index fields.removeAt(2); Assert.assertEquals(fields.getCount(), 3); // Remove all fields from the document fields.clear(); Assert.assertEquals(fields.getCount(), 0); } /// <summary> /// Document visitor implementation that prints field info /// </summary> public static class FieldVisitor extends DocumentVisitor { public FieldVisitor() { mBuilder = new StringBuilder(); } /// <summary> /// Gets the plain text of the document that was accumulated by the visitor. /// </summary> public String getText() { return mBuilder.toString(); } /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public int visitFieldStart(final FieldStart fieldStart) { mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n"); mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n"); mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public int visitFieldSeparator(final FieldSeparator fieldSeparator) { mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public int visitFieldEnd(final FieldEnd fieldEnd) { mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; }
getFormat | → inherited from Field |
public FieldFormat getFormat() |
Example:
Shows how to formatting fieldsDocument 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");
getIncludeNoteOrComment/setIncludeNoteOrComment | |
public boolean getIncludeNoteOrComment() / public void setIncludeNoteOrComment(boolean value) |
Example:
Shows how to insert REF fields to reference bookmarks and present them in various ways.public void fieldRef() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert the bookmark that all our REF fields will reference and leave it at the end of the document builder.startBookmark("MyBookmark"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #1"); builder.write("Text that will appear in REF field"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #2"); builder.endBookmark("MyBookmark"); builder.moveToDocumentStart(); // We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at // Note that the angle brackets count as non-delimiter characters builder.getListFormat().applyNumberDefault(); builder.getListFormat().getListLevel().setNumberFormat("> \u0000"); // Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes FieldRef field = insertFieldRef(builder, "MyBookmark", "", "\n"); field.setIncludeNoteOrComment(true); field.setInsertHyperlink(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\f \\h"); // Insert a REF field and display whether the referenced bookmark is above or below it field = insertFieldRef(builder, "MyBookmark", "The referenced paragraph is ", " this field.\n"); field.setInsertRelativePosition(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\p"); // Display the list number of the bookmark, as it appears in the document field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number is ", "\n"); field.setInsertParagraphNumber(true); Assert.assertEquals(" REF MyBookmark \\n", field.getFieldCode()); // Display the list number of the bookmark, but with non-delimiter characters omitted // In this case they are the angle brackets field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number, non-delimiters suppressed, is ", "\n"); field.setInsertParagraphNumber(true); field.setSuppressNonDelimiters(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\n \\t"); // Move down one list level builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">> \u0001"); // Display the list number of the bookmark as well as the numbers of all the list levels above it field = insertFieldRef(builder, "MyBookmark", "The bookmark's full context paragraph number is ", "\n"); field.setInsertParagraphNumberInFullContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\w"); builder.insertBreak(BreakType.PAGE_BREAK); // Display the list level numbers between this REF field and the bookmark that it is referencing field = insertFieldRef(builder, "MyBookmark", "The bookmark's relative paragraph number is ", "\n"); field.setInsertParagraphNumberInRelativeContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\r"); // The bookmark, which is at the end of the document, will show up as a list item here builder.writeln("List level above bookmark"); builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">>> \u0002"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.Ref.docx"); } /// <summary> /// Get the document builder to insert a REF field, reference a bookmark with it, and add text before and after /// </summary> private FieldRef insertFieldRef(final DocumentBuilder builder, final String bookmarkName, final String textBefore, final String textAfter) throws Exception { builder.write(textBefore); FieldRef field = (FieldRef) builder.insertField(FieldType.FIELD_REF, true); field.setBookmarkName(bookmarkName); builder.write(textAfter); return field; }
getInsertHyperlink/setInsertHyperlink | |
public boolean getInsertHyperlink() / public void setInsertHyperlink(boolean value) |
Example:
Shows how to insert REF fields to reference bookmarks and present them in various ways.public void fieldRef() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert the bookmark that all our REF fields will reference and leave it at the end of the document builder.startBookmark("MyBookmark"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #1"); builder.write("Text that will appear in REF field"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #2"); builder.endBookmark("MyBookmark"); builder.moveToDocumentStart(); // We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at // Note that the angle brackets count as non-delimiter characters builder.getListFormat().applyNumberDefault(); builder.getListFormat().getListLevel().setNumberFormat("> \u0000"); // Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes FieldRef field = insertFieldRef(builder, "MyBookmark", "", "\n"); field.setIncludeNoteOrComment(true); field.setInsertHyperlink(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\f \\h"); // Insert a REF field and display whether the referenced bookmark is above or below it field = insertFieldRef(builder, "MyBookmark", "The referenced paragraph is ", " this field.\n"); field.setInsertRelativePosition(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\p"); // Display the list number of the bookmark, as it appears in the document field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number is ", "\n"); field.setInsertParagraphNumber(true); Assert.assertEquals(" REF MyBookmark \\n", field.getFieldCode()); // Display the list number of the bookmark, but with non-delimiter characters omitted // In this case they are the angle brackets field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number, non-delimiters suppressed, is ", "\n"); field.setInsertParagraphNumber(true); field.setSuppressNonDelimiters(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\n \\t"); // Move down one list level builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">> \u0001"); // Display the list number of the bookmark as well as the numbers of all the list levels above it field = insertFieldRef(builder, "MyBookmark", "The bookmark's full context paragraph number is ", "\n"); field.setInsertParagraphNumberInFullContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\w"); builder.insertBreak(BreakType.PAGE_BREAK); // Display the list level numbers between this REF field and the bookmark that it is referencing field = insertFieldRef(builder, "MyBookmark", "The bookmark's relative paragraph number is ", "\n"); field.setInsertParagraphNumberInRelativeContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\r"); // The bookmark, which is at the end of the document, will show up as a list item here builder.writeln("List level above bookmark"); builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">>> \u0002"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.Ref.docx"); } /// <summary> /// Get the document builder to insert a REF field, reference a bookmark with it, and add text before and after /// </summary> private FieldRef insertFieldRef(final DocumentBuilder builder, final String bookmarkName, final String textBefore, final String textAfter) throws Exception { builder.write(textBefore); FieldRef field = (FieldRef) builder.insertField(FieldType.FIELD_REF, true); field.setBookmarkName(bookmarkName); builder.write(textAfter); return field; }
getInsertParagraphNumber/setInsertParagraphNumber | |
public boolean getInsertParagraphNumber() / public void setInsertParagraphNumber(boolean value) |
Example:
Shows how to insert REF fields to reference bookmarks and present them in various ways.public void fieldRef() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert the bookmark that all our REF fields will reference and leave it at the end of the document builder.startBookmark("MyBookmark"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #1"); builder.write("Text that will appear in REF field"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #2"); builder.endBookmark("MyBookmark"); builder.moveToDocumentStart(); // We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at // Note that the angle brackets count as non-delimiter characters builder.getListFormat().applyNumberDefault(); builder.getListFormat().getListLevel().setNumberFormat("> \u0000"); // Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes FieldRef field = insertFieldRef(builder, "MyBookmark", "", "\n"); field.setIncludeNoteOrComment(true); field.setInsertHyperlink(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\f \\h"); // Insert a REF field and display whether the referenced bookmark is above or below it field = insertFieldRef(builder, "MyBookmark", "The referenced paragraph is ", " this field.\n"); field.setInsertRelativePosition(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\p"); // Display the list number of the bookmark, as it appears in the document field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number is ", "\n"); field.setInsertParagraphNumber(true); Assert.assertEquals(" REF MyBookmark \\n", field.getFieldCode()); // Display the list number of the bookmark, but with non-delimiter characters omitted // In this case they are the angle brackets field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number, non-delimiters suppressed, is ", "\n"); field.setInsertParagraphNumber(true); field.setSuppressNonDelimiters(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\n \\t"); // Move down one list level builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">> \u0001"); // Display the list number of the bookmark as well as the numbers of all the list levels above it field = insertFieldRef(builder, "MyBookmark", "The bookmark's full context paragraph number is ", "\n"); field.setInsertParagraphNumberInFullContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\w"); builder.insertBreak(BreakType.PAGE_BREAK); // Display the list level numbers between this REF field and the bookmark that it is referencing field = insertFieldRef(builder, "MyBookmark", "The bookmark's relative paragraph number is ", "\n"); field.setInsertParagraphNumberInRelativeContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\r"); // The bookmark, which is at the end of the document, will show up as a list item here builder.writeln("List level above bookmark"); builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">>> \u0002"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.Ref.docx"); } /// <summary> /// Get the document builder to insert a REF field, reference a bookmark with it, and add text before and after /// </summary> private FieldRef insertFieldRef(final DocumentBuilder builder, final String bookmarkName, final String textBefore, final String textAfter) throws Exception { builder.write(textBefore); FieldRef field = (FieldRef) builder.insertField(FieldType.FIELD_REF, true); field.setBookmarkName(bookmarkName); builder.write(textAfter); return field; }
getInsertParagraphNumberInFullContext/setInsertParagraphNumberInFullContext | |
public boolean getInsertParagraphNumberInFullContext() / public void setInsertParagraphNumberInFullContext(boolean value) |
Example:
Shows how to insert REF fields to reference bookmarks and present them in various ways.public void fieldRef() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert the bookmark that all our REF fields will reference and leave it at the end of the document builder.startBookmark("MyBookmark"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #1"); builder.write("Text that will appear in REF field"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #2"); builder.endBookmark("MyBookmark"); builder.moveToDocumentStart(); // We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at // Note that the angle brackets count as non-delimiter characters builder.getListFormat().applyNumberDefault(); builder.getListFormat().getListLevel().setNumberFormat("> \u0000"); // Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes FieldRef field = insertFieldRef(builder, "MyBookmark", "", "\n"); field.setIncludeNoteOrComment(true); field.setInsertHyperlink(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\f \\h"); // Insert a REF field and display whether the referenced bookmark is above or below it field = insertFieldRef(builder, "MyBookmark", "The referenced paragraph is ", " this field.\n"); field.setInsertRelativePosition(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\p"); // Display the list number of the bookmark, as it appears in the document field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number is ", "\n"); field.setInsertParagraphNumber(true); Assert.assertEquals(" REF MyBookmark \\n", field.getFieldCode()); // Display the list number of the bookmark, but with non-delimiter characters omitted // In this case they are the angle brackets field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number, non-delimiters suppressed, is ", "\n"); field.setInsertParagraphNumber(true); field.setSuppressNonDelimiters(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\n \\t"); // Move down one list level builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">> \u0001"); // Display the list number of the bookmark as well as the numbers of all the list levels above it field = insertFieldRef(builder, "MyBookmark", "The bookmark's full context paragraph number is ", "\n"); field.setInsertParagraphNumberInFullContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\w"); builder.insertBreak(BreakType.PAGE_BREAK); // Display the list level numbers between this REF field and the bookmark that it is referencing field = insertFieldRef(builder, "MyBookmark", "The bookmark's relative paragraph number is ", "\n"); field.setInsertParagraphNumberInRelativeContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\r"); // The bookmark, which is at the end of the document, will show up as a list item here builder.writeln("List level above bookmark"); builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">>> \u0002"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.Ref.docx"); } /// <summary> /// Get the document builder to insert a REF field, reference a bookmark with it, and add text before and after /// </summary> private FieldRef insertFieldRef(final DocumentBuilder builder, final String bookmarkName, final String textBefore, final String textAfter) throws Exception { builder.write(textBefore); FieldRef field = (FieldRef) builder.insertField(FieldType.FIELD_REF, true); field.setBookmarkName(bookmarkName); builder.write(textAfter); return field; }
getInsertParagraphNumberInRelativeContext/setInsertParagraphNumberInRelativeContext | |
public boolean getInsertParagraphNumberInRelativeContext() / public void setInsertParagraphNumberInRelativeContext(boolean value) |
Example:
Shows how to insert REF fields to reference bookmarks and present them in various ways.public void fieldRef() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert the bookmark that all our REF fields will reference and leave it at the end of the document builder.startBookmark("MyBookmark"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #1"); builder.write("Text that will appear in REF field"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #2"); builder.endBookmark("MyBookmark"); builder.moveToDocumentStart(); // We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at // Note that the angle brackets count as non-delimiter characters builder.getListFormat().applyNumberDefault(); builder.getListFormat().getListLevel().setNumberFormat("> \u0000"); // Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes FieldRef field = insertFieldRef(builder, "MyBookmark", "", "\n"); field.setIncludeNoteOrComment(true); field.setInsertHyperlink(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\f \\h"); // Insert a REF field and display whether the referenced bookmark is above or below it field = insertFieldRef(builder, "MyBookmark", "The referenced paragraph is ", " this field.\n"); field.setInsertRelativePosition(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\p"); // Display the list number of the bookmark, as it appears in the document field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number is ", "\n"); field.setInsertParagraphNumber(true); Assert.assertEquals(" REF MyBookmark \\n", field.getFieldCode()); // Display the list number of the bookmark, but with non-delimiter characters omitted // In this case they are the angle brackets field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number, non-delimiters suppressed, is ", "\n"); field.setInsertParagraphNumber(true); field.setSuppressNonDelimiters(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\n \\t"); // Move down one list level builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">> \u0001"); // Display the list number of the bookmark as well as the numbers of all the list levels above it field = insertFieldRef(builder, "MyBookmark", "The bookmark's full context paragraph number is ", "\n"); field.setInsertParagraphNumberInFullContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\w"); builder.insertBreak(BreakType.PAGE_BREAK); // Display the list level numbers between this REF field and the bookmark that it is referencing field = insertFieldRef(builder, "MyBookmark", "The bookmark's relative paragraph number is ", "\n"); field.setInsertParagraphNumberInRelativeContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\r"); // The bookmark, which is at the end of the document, will show up as a list item here builder.writeln("List level above bookmark"); builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">>> \u0002"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.Ref.docx"); } /// <summary> /// Get the document builder to insert a REF field, reference a bookmark with it, and add text before and after /// </summary> private FieldRef insertFieldRef(final DocumentBuilder builder, final String bookmarkName, final String textBefore, final String textAfter) throws Exception { builder.write(textBefore); FieldRef field = (FieldRef) builder.insertField(FieldType.FIELD_REF, true); field.setBookmarkName(bookmarkName); builder.write(textAfter); return field; }
getInsertRelativePosition/setInsertRelativePosition | |
public boolean getInsertRelativePosition() / public void setInsertRelativePosition(boolean value) |
Example:
Shows how to insert REF fields to reference bookmarks and present them in various ways.public void fieldRef() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert the bookmark that all our REF fields will reference and leave it at the end of the document builder.startBookmark("MyBookmark"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #1"); builder.write("Text that will appear in REF field"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #2"); builder.endBookmark("MyBookmark"); builder.moveToDocumentStart(); // We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at // Note that the angle brackets count as non-delimiter characters builder.getListFormat().applyNumberDefault(); builder.getListFormat().getListLevel().setNumberFormat("> \u0000"); // Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes FieldRef field = insertFieldRef(builder, "MyBookmark", "", "\n"); field.setIncludeNoteOrComment(true); field.setInsertHyperlink(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\f \\h"); // Insert a REF field and display whether the referenced bookmark is above or below it field = insertFieldRef(builder, "MyBookmark", "The referenced paragraph is ", " this field.\n"); field.setInsertRelativePosition(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\p"); // Display the list number of the bookmark, as it appears in the document field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number is ", "\n"); field.setInsertParagraphNumber(true); Assert.assertEquals(" REF MyBookmark \\n", field.getFieldCode()); // Display the list number of the bookmark, but with non-delimiter characters omitted // In this case they are the angle brackets field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number, non-delimiters suppressed, is ", "\n"); field.setInsertParagraphNumber(true); field.setSuppressNonDelimiters(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\n \\t"); // Move down one list level builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">> \u0001"); // Display the list number of the bookmark as well as the numbers of all the list levels above it field = insertFieldRef(builder, "MyBookmark", "The bookmark's full context paragraph number is ", "\n"); field.setInsertParagraphNumberInFullContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\w"); builder.insertBreak(BreakType.PAGE_BREAK); // Display the list level numbers between this REF field and the bookmark that it is referencing field = insertFieldRef(builder, "MyBookmark", "The bookmark's relative paragraph number is ", "\n"); field.setInsertParagraphNumberInRelativeContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\r"); // The bookmark, which is at the end of the document, will show up as a list item here builder.writeln("List level above bookmark"); builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">>> \u0002"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.Ref.docx"); } /// <summary> /// Get the document builder to insert a REF field, reference a bookmark with it, and add text before and after /// </summary> private FieldRef insertFieldRef(final DocumentBuilder builder, final String bookmarkName, final String textBefore, final String textAfter) throws Exception { builder.write(textBefore); FieldRef field = (FieldRef) builder.insertField(FieldType.FIELD_REF, true); field.setBookmarkName(bookmarkName); builder.write(textAfter); 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 resultDocument 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) |
Example:
Demonstrates how to retrieve the field class from an existing FieldStart node in the document.Document doc = new Document(getMyDir() + "Document.TableOfContents.doc"); FieldChar fieldStart = (FieldChar) doc.getChild(NodeType.FIELD_START, 0, true); Assert.assertEquals(fieldStart.getFieldType(), FieldType.FIELD_TOC); Assert.assertEquals(fieldStart.isDirty(), true); Assert.assertEquals(fieldStart.isLocked(), false); // Retrieve the facade object which represents the field in the document. Field field = fieldStart.getField(); Assert.assertEquals(false, field.isLocked()); Assert.assertEquals(" TOC \\o \"1-3\" \\h \\z \\u ", field.getFieldCode()); // This updates only this field in the document. field.update();
getLocaleId/setLocaleId | → inherited from Field |
public int getLocaleId() / public void setLocaleId(int value) |
Example:
Get or sets locale for fieldsDocument 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);
getNumberSeparator/setNumberSeparator | |
public java.lang.String getNumberSeparator() / public void setNumberSeparator(java.lang.String value) |
Example:
Shows how to insert REF fields to reference bookmarks and present them in various ways.public void fieldRef() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert the bookmark that all our REF fields will reference and leave it at the end of the document builder.startBookmark("MyBookmark"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #1"); builder.write("Text that will appear in REF field"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #2"); builder.endBookmark("MyBookmark"); builder.moveToDocumentStart(); // We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at // Note that the angle brackets count as non-delimiter characters builder.getListFormat().applyNumberDefault(); builder.getListFormat().getListLevel().setNumberFormat("> \u0000"); // Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes FieldRef field = insertFieldRef(builder, "MyBookmark", "", "\n"); field.setIncludeNoteOrComment(true); field.setInsertHyperlink(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\f \\h"); // Insert a REF field and display whether the referenced bookmark is above or below it field = insertFieldRef(builder, "MyBookmark", "The referenced paragraph is ", " this field.\n"); field.setInsertRelativePosition(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\p"); // Display the list number of the bookmark, as it appears in the document field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number is ", "\n"); field.setInsertParagraphNumber(true); Assert.assertEquals(" REF MyBookmark \\n", field.getFieldCode()); // Display the list number of the bookmark, but with non-delimiter characters omitted // In this case they are the angle brackets field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number, non-delimiters suppressed, is ", "\n"); field.setInsertParagraphNumber(true); field.setSuppressNonDelimiters(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\n \\t"); // Move down one list level builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">> \u0001"); // Display the list number of the bookmark as well as the numbers of all the list levels above it field = insertFieldRef(builder, "MyBookmark", "The bookmark's full context paragraph number is ", "\n"); field.setInsertParagraphNumberInFullContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\w"); builder.insertBreak(BreakType.PAGE_BREAK); // Display the list level numbers between this REF field and the bookmark that it is referencing field = insertFieldRef(builder, "MyBookmark", "The bookmark's relative paragraph number is ", "\n"); field.setInsertParagraphNumberInRelativeContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\r"); // The bookmark, which is at the end of the document, will show up as a list item here builder.writeln("List level above bookmark"); builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">>> \u0002"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.Ref.docx"); } /// <summary> /// Get the document builder to insert a REF field, reference a bookmark with it, and add text before and after /// </summary> private FieldRef insertFieldRef(final DocumentBuilder builder, final String bookmarkName, final String textBefore, final String textAfter) throws Exception { builder.write(textBefore); FieldRef field = (FieldRef) builder.insertField(FieldType.FIELD_REF, true); field.setBookmarkName(bookmarkName); builder.write(textAfter); 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 behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9. System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object. dateField.remove();
getSeparator | → inherited from Field |
public FieldSeparator getSeparator() |
Example:
Shows how to work with a document's field collection.public void fieldCollection() throws Exception { // Open a document that has fields Document doc = new Document(getMyDir() + "Document.ContainsFields.docx"); // Get the collection that contains all the fields in a document FieldCollection fields = doc.getRange().getFields(); Assert.assertEquals(fields.getCount(), 6); // Iterate over the field collection and print contents and type of every field using a custom visitor implementation FieldVisitor fieldVisitor = new FieldVisitor(); Iterator<Field> fieldEnumerator = fields.iterator(); while (fieldEnumerator.hasNext()) { if (fieldEnumerator.next() != null) { Field currentField = fieldEnumerator.next(); currentField.getStart().accept(fieldVisitor); if (currentField.getSeparator() != null) { currentField.getSeparator().accept(fieldVisitor); } currentField.getEnd().accept(fieldVisitor); } else { System.out.println("There are no fields in the document."); } } System.out.println(fieldVisitor.getText()); // Get a field to remove itself fields.get(0).remove(); Assert.assertEquals(fields.getCount(), 5); // Remove a field by reference Field lastField = fields.get(3); fields.remove(lastField); Assert.assertEquals(fields.getCount(), 4); // Remove a field by index fields.removeAt(2); Assert.assertEquals(fields.getCount(), 3); // Remove all fields from the document fields.clear(); Assert.assertEquals(fields.getCount(), 0); } /// <summary> /// Document visitor implementation that prints field info /// </summary> public static class FieldVisitor extends DocumentVisitor { public FieldVisitor() { mBuilder = new StringBuilder(); } /// <summary> /// Gets the plain text of the document that was accumulated by the visitor. /// </summary> public String getText() { return mBuilder.toString(); } /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public int visitFieldStart(final FieldStart fieldStart) { mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n"); mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n"); mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public int visitFieldSeparator(final FieldSeparator fieldSeparator) { mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n"); return VisitorAction.CONTINUE; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public int visitFieldEnd(final FieldEnd fieldEnd) { mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n"); return VisitorAction.CONTINUE; } private StringBuilder mBuilder; }
getStart | → inherited from Field |
public FieldStart getStart() |
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; }
getSuppressNonDelimiters/setSuppressNonDelimiters | |
public boolean getSuppressNonDelimiters() / public void setSuppressNonDelimiters(boolean value) |
Example:
Shows how to insert REF fields to reference bookmarks and present them in various ways.public void fieldRef() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert the bookmark that all our REF fields will reference and leave it at the end of the document builder.startBookmark("MyBookmark"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #1"); builder.write("Text that will appear in REF field"); builder.insertFootnote(FootnoteType.FOOTNOTE, "MyBookmark footnote #2"); builder.endBookmark("MyBookmark"); builder.moveToDocumentStart(); // We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at // Note that the angle brackets count as non-delimiter characters builder.getListFormat().applyNumberDefault(); builder.getListFormat().getListLevel().setNumberFormat("> \u0000"); // Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes FieldRef field = insertFieldRef(builder, "MyBookmark", "", "\n"); field.setIncludeNoteOrComment(true); field.setInsertHyperlink(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\f \\h"); // Insert a REF field and display whether the referenced bookmark is above or below it field = insertFieldRef(builder, "MyBookmark", "The referenced paragraph is ", " this field.\n"); field.setInsertRelativePosition(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\p"); // Display the list number of the bookmark, as it appears in the document field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number is ", "\n"); field.setInsertParagraphNumber(true); Assert.assertEquals(" REF MyBookmark \\n", field.getFieldCode()); // Display the list number of the bookmark, but with non-delimiter characters omitted // In this case they are the angle brackets field = insertFieldRef(builder, "MyBookmark", "The bookmark's paragraph number, non-delimiters suppressed, is ", "\n"); field.setInsertParagraphNumber(true); field.setSuppressNonDelimiters(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\n \\t"); // Move down one list level builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">> \u0001"); // Display the list number of the bookmark as well as the numbers of all the list levels above it field = insertFieldRef(builder, "MyBookmark", "The bookmark's full context paragraph number is ", "\n"); field.setInsertParagraphNumberInFullContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\w"); builder.insertBreak(BreakType.PAGE_BREAK); // Display the list level numbers between this REF field and the bookmark that it is referencing field = insertFieldRef(builder, "MyBookmark", "The bookmark's relative paragraph number is ", "\n"); field.setInsertParagraphNumberInRelativeContext(true); Assert.assertEquals(field.getFieldCode(), " REF MyBookmark \\r"); // The bookmark, which is at the end of the document, will show up as a list item here builder.writeln("List level above bookmark"); builder.getListFormat().setListLevelNumber(builder.getListFormat().getListLevelNumber() + 1)/*Property++*/; builder.getListFormat().getListLevel().setNumberFormat(">>> \u0002"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.Ref.docx"); } /// <summary> /// Get the document builder to insert a REF field, reference a bookmark with it, and add text before and after /// </summary> private FieldRef insertFieldRef(final DocumentBuilder builder, final String bookmarkName, final String textBefore, final String textAfter) throws Exception { builder.write(textBefore); FieldRef field = (FieldRef) builder.insertField(FieldType.FIELD_REF, true); field.setBookmarkName(bookmarkName); builder.write(textAfter); return field; }
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 behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9. System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object. dateField.remove();
Method Detail |
---|
getFieldCode | → 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 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) |
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 |
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 |
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 fieldDocument doc = new Document(getMyDir() + "Field.UnlinkFields.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 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 |
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 switchLoadOptions 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");