java.lang.ObjectField
com.aspose.words.FieldSeq
public class FieldSeq
Example: Example: Example:
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Set the current number of the sequence to 100
builder.write("#");
FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true);
fieldSeq.setSequenceIdentifier("MySequence");
fieldSeq.setResetNumber("100");
Assert.assertEquals(" SEQ MySequence \\r 100", fieldSeq.getFieldCode());
builder.write(", #");
fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true);
fieldSeq.setSequenceIdentifier("MySequence");
// Insert a heading
builder.insertBreak(BreakType.PARAGRAPH_BREAK);
builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1"));
builder.writeln("This level 1 heading will reset MySequence to 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Reset the sequence back to 1 when we encounter a heading of a specified level, which in this case is "1", same as the heading above
builder.write("\n#");
fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true);
fieldSeq.setSequenceIdentifier("MySequence");
fieldSeq.setResetHeadingLevel("1");
Assert.assertEquals(" SEQ MySequence \\s 1", fieldSeq.getFieldCode());
// Move to the next number
builder.write(", #");
fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true);
fieldSeq.setSequenceIdentifier("MySequence");
fieldSeq.setInsertNextNumber(true);
Assert.assertEquals(" SEQ MySequence \\n", fieldSeq.getFieldCode());
doc.updateFields();
doc.save(getArtifactsDir() + "Field.SEQ.ResetNumbering.docx");
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a TOC field that creates a table of contents entry for each paragraph
// that contains a SEQ field with a sequence identifier of "MySequence" with the number of the page which contains that field
FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true);
fieldToc.setTableOfFiguresLabel("MySequence");
// This identifier is for a parallel SEQ sequence,
// the number that it is at will be displayed in front of the page number of the paragraph with the other sequence,
// separated by a sequence separator character also defined below
fieldToc.setPrefixedSequenceIdentifier("PrefixSequence");
fieldToc.setSequenceSeparator(">");
Assert.assertEquals(" TOC \\c MySequence \\s PrefixSequence \\d >", fieldToc.getFieldCode());
builder.insertBreak(BreakType.PAGE_BREAK);
// Insert a SEQ field to increment the sequence counter of "PrefixSequence" to 1
// Since this paragraph doesn't contain a SEQ field of the "MySequence" sequence,
// this will not appear as an entry in the TOC
FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true);
fieldSeq.setSequenceIdentifier("PrefixSequence");
builder.insertParagraph();
Assert.assertEquals(" SEQ PrefixSequence", fieldSeq.getFieldCode());
// Insert two SEQ fields, one for each of the sequences we defined above
// The "MySequence" SEQ appears on page 2 and the "PrefixSequence" is at number 1 in this paragraph,
// which means that our TOC will display this as an entry with the contents on the left and "1>2" on the right
builder.write("First TOC entry, MySequence #");
fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true);
fieldSeq.setSequenceIdentifier("MySequence");
doc.updateFields();
doc.save(getArtifactsDir() + "Field.TOC.SEQ.docx");
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// This TOC takes in all SEQ fields with "MySequence" inside "TOCBookmark"
FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true);
fieldToc.setTableOfFiguresLabel("MySequence");
fieldToc.setBookmarkName("TOCBookmark");
builder.insertBreak(BreakType.PAGE_BREAK);
Assert.assertEquals(" TOC \\c MySequence \\b TOCBookmark", fieldToc.getFieldCode());
builder.write("MySequence #");
FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true);
fieldSeq.setSequenceIdentifier("MySequence");
builder.writeln(", won't show up in the TOC because it is outside of the bookmark.");
builder.startBookmark("TOCBookmark");
builder.write("MySequence #");
fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true);
fieldSeq.setSequenceIdentifier("MySequence");
builder.writeln(", will show up in the TOC next to the entry for the above caption.");
builder.write("MySequence #");
fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true);
fieldSeq.setSequenceIdentifier("OtherSequence");
builder.writeln(", won't show up in the TOC because it's from a different sequence identifier.");
// The contents of the bookmark we reference here will not appear at the SEQ field, but will appear in the corresponding TOC entry
fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true);
fieldSeq.setSequenceIdentifier("MySequence");
fieldSeq.setBookmarkName("SEQBookmark");
Assert.assertEquals(" SEQ MySequence SEQBookmark", fieldSeq.getFieldCode());
// Add bookmark to reference
builder.insertBreak(BreakType.PAGE_BREAK);
builder.startBookmark("SEQBookmark");
builder.write("MySequence #");
fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true);
fieldSeq.setSequenceIdentifier("MySequence");
builder.writeln(", text from inside SEQBookmark.");
builder.endBookmark("SEQBookmark");
builder.endBookmark("TOCBookmark");
doc.updateFields();
doc.save(getArtifactsDir() + "Field.SEQ.Bookmark.docx");
Constructor Summary |
---|
FieldSeq()
|
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getBookmarkName() | |
void | setBookmarkName(java.lang.String value) | |
Gets or sets a bookmark name that refers to an item elsewhere in the document rather than in the current location. | ||
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 | getInsertNextNumber() | |
void | setInsertNextNumber(boolean value) | |
Gets or sets whether to insert the next sequence number for the specified item. | ||
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 | getResetHeadingLevel() | |
void | setResetHeadingLevel(java.lang.String value) | |
Gets or sets an integer number representing a heading level to reset the sequence number to. Returns -1 if the number is absent. | ||
java.lang.String | getResetNumber() | |
void | setResetNumber(java.lang.String value) | |
Gets or sets an integer number to reset the sequence number to. Returns -1 if the number is absent. | ||
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 | getSequenceIdentifier() | |
void | setSequenceIdentifier(java.lang.String value) | |
Gets or sets the name assigned to the series of items that are to be numbered. | ||
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 FieldSeq()
Property Getters/Setters Detail |
---|
getBookmarkName/setBookmarkName | |
public java.lang.String getBookmarkName() / public void setBookmarkName(java.lang.String value) |
Example:
Shows how to combine table of contents and sequence fields.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // This TOC takes in all SEQ fields with "MySequence" inside "TOCBookmark" FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); fieldToc.setTableOfFiguresLabel("MySequence"); fieldToc.setBookmarkName("TOCBookmark"); builder.insertBreak(BreakType.PAGE_BREAK); Assert.assertEquals(" TOC \\c MySequence \\b TOCBookmark", fieldToc.getFieldCode()); builder.write("MySequence #"); FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); builder.writeln(", won't show up in the TOC because it is outside of the bookmark."); builder.startBookmark("TOCBookmark"); builder.write("MySequence #"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); builder.writeln(", will show up in the TOC next to the entry for the above caption."); builder.write("MySequence #"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("OtherSequence"); builder.writeln(", won't show up in the TOC because it's from a different sequence identifier."); // The contents of the bookmark we reference here will not appear at the SEQ field, but will appear in the corresponding TOC entry fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setBookmarkName("SEQBookmark"); Assert.assertEquals(" SEQ MySequence SEQBookmark", fieldSeq.getFieldCode()); // Add bookmark to reference builder.insertBreak(BreakType.PAGE_BREAK); builder.startBookmark("SEQBookmark"); builder.write("MySequence #"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); builder.writeln(", text from inside SEQBookmark."); builder.endBookmark("SEQBookmark"); builder.endBookmark("TOCBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.SEQ.Bookmark.docx");
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("111", fields.get(0).getDisplayResult()); Assert.assertEquals("222", fields.get(1).getDisplayResult()); Assert.assertEquals("Multi\rLine\rText", fields.get(2).getDisplayResult()); Assert.assertEquals("%", fields.get(3).getDisplayResult()); Assert.assertEquals("Macro Button Text", fields.get(4).getDisplayResult()); Assert.assertEquals("", fields.get(5).getDisplayResult()); // Method must be called to obtain correct value for the "FieldListNum", "FieldAutoNum", // "FieldAutoNumOut" and "FieldAutoNumLgl" fields document.updateListLabels(); Assert.assertEquals("1)", fields.get(5).getDisplayResult());
getEnd | → 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; }
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(); Assert.assertEquals("$ 5.00", field.getResult()); // Apply a date/time format field = builder.insertField("DATE"); format = field.getFormat(); format.setDateTimeFormat("dddd, MMMM dd, yyyy"); field.update(); System.out.println("Today's date, in {format.DateTimeFormat} format:\n\t{field.Result}"); // Apply 2 general formats at the same time field = builder.insertField("= 25 + 33"); format = field.getFormat(); format.getGeneralFormats().add(GeneralFormat.LOWERCASE_ROMAN); format.getGeneralFormats().add(GeneralFormat.UPPER); field.update(); int index = 0; Iterator<Integer> generalFormatEnumerator = format.getGeneralFormats().iterator(); while (generalFormatEnumerator.hasNext()) { System.out.println(MessageFormat.format("General format index {0}: {1}", index++, generalFormatEnumerator.toString())); } Assert.assertEquals("LVIII", field.getResult()); Assert.assertEquals(2, format.getGeneralFormats().getCount()); Assert.assertEquals(format.getGeneralFormats().get(0), GeneralFormat.LOWERCASE_ROMAN); // Removing field formats format.getGeneralFormats().remove(GeneralFormat.LOWERCASE_ROMAN); format.getGeneralFormats().removeAt(0); Assert.assertEquals(format.getGeneralFormats().getCount(), 0); field.update(); // Our field has no general formats left and is back to default form Assert.assertEquals(field.getResult(), "58");
getInsertNextNumber/setInsertNextNumber | |
public boolean getInsertNextNumber() / public void setInsertNextNumber(boolean value) |
Example:
Shows how to reset numbering of a SEQ field.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Set the current number of the sequence to 100 builder.write("#"); FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setResetNumber("100"); Assert.assertEquals(" SEQ MySequence \\r 100", fieldSeq.getFieldCode()); builder.write(", #"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); // Insert a heading builder.insertBreak(BreakType.PARAGRAPH_BREAK); builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1")); builder.writeln("This level 1 heading will reset MySequence to 1"); builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal")); // Reset the sequence back to 1 when we encounter a heading of a specified level, which in this case is "1", same as the heading above builder.write("\n#"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setResetHeadingLevel("1"); Assert.assertEquals(" SEQ MySequence \\s 1", fieldSeq.getFieldCode()); // Move to the next number builder.write(", #"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setInsertNextNumber(true); Assert.assertEquals(" SEQ MySequence \\n", fieldSeq.getFieldCode()); doc.updateFields(); doc.save(getArtifactsDir() + "Field.SEQ.ResetNumbering.docx");
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); // Give the document's built in property "Author" a value and display it with a field doc.getBuiltInDocumentProperties().setAuthor("John Doe"); FieldAuthor field = (FieldAuthor) builder.insertField(FieldType.FIELD_AUTHOR, true); Assert.assertFalse(field.isDirty()); Assert.assertEquals("John Doe", field.getResult()); // Update the "Author" property doc.getBuiltInDocumentProperties().setAuthor("John & Jane Doe"); // AUTHOR is one of the field types whose fields do not update according to their source values in real time, // and need to be updated manually beforehand every time an accurate value is required Assert.assertEquals("John Doe", field.getResult()); // Since the field's value is out of date, we can mark it as "Dirty" field.isDirty(true); OutputStream docStream = new FileOutputStream(getArtifactsDir() + "Filed.UpdateDirtyFields.docx"); try { doc.save(docStream, SaveFormat.DOCX); // Re-open the document from the stream while using a LoadOptions object to specify // whether to update all fields marked as "Dirty" in the process, so they can display accurate values immediately LoadOptions options = new LoadOptions(); options.setUpdateDirtyFields(doUpdateDirtyFields); doc = new Document(String.valueOf(docStream), options); Assert.assertEquals("John & Jane Doe", doc.getBuiltInDocumentProperties().getAuthor()); field = (FieldAuthor) doc.getRange().getFields().get(0); if (doUpdateDirtyFields) { Assert.assertEquals("John & Jane Doe", field.getResult()); Assert.assertFalse(field.isDirty()); } else { Assert.assertEquals("John Doe", field.getResult()); Assert.assertTrue(field.isDirty()); } } finally { if (docStream != null) docStream.close(); }
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(); DocumentBuilder builder = new DocumentBuilder(doc); FieldDate field = (FieldDate) builder.insertField(FieldType.FIELD_DATE, true); field.getFormat().setDateTimeFormat("dddd, MMMM dd, yyyy"); field.update(); FieldChar fieldStart = field.getStart(); Assert.assertEquals(FieldType.FIELD_DATE, fieldStart.getFieldType()); Assert.assertEquals(false, fieldStart.isDirty()); Assert.assertEquals(false, fieldStart.isLocked()); // Retrieve the facade object which represents the field in the document field = (FieldDate) fieldStart.getField(); Assert.assertEquals(false, field.isLocked()); Assert.assertEquals(" DATE \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode()); // This updates only this field in the document field.update();
getLocaleId/setLocaleId | → inherited from Field |
public int getLocaleId() / public void setLocaleId(int value) |
Example:
Shows how to insert a field and work with its locale.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a DATE field and print the date it will display, formatted according to your thread's current culture Field field = builder.insertField("DATE"); System.out.println(MessageFormat.format("Today's date, as displayed in the \"{0}\" culture: {1}", Locale.getDefault().getDisplayName(), field.getResult())); Assert.assertEquals(1033, field.getLocaleId()); // We can get the field to display a date in a different format if we change the current thread's culture // If we want to avoid making such an all encompassing change, // we can set this option to get the document's fields to get their culture from themselves // Then, we can change a field's LocaleId and it will display its result in any culture we choose doc.getFieldOptions().setFieldUpdateCultureSource(FieldUpdateCultureSource.FIELD_CODE); field.setLocaleId(1031); field.update(); System.out.println(MessageFormat.format("Today's date, as displayed according to the \"{0}\" culture: {1}", field.getLocaleId(), field.getResult()));
getResetHeadingLevel/setResetHeadingLevel | |
public java.lang.String getResetHeadingLevel() / public void setResetHeadingLevel(java.lang.String value) |
Example:
Shows how to reset numbering of a SEQ field.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Set the current number of the sequence to 100 builder.write("#"); FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setResetNumber("100"); Assert.assertEquals(" SEQ MySequence \\r 100", fieldSeq.getFieldCode()); builder.write(", #"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); // Insert a heading builder.insertBreak(BreakType.PARAGRAPH_BREAK); builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1")); builder.writeln("This level 1 heading will reset MySequence to 1"); builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal")); // Reset the sequence back to 1 when we encounter a heading of a specified level, which in this case is "1", same as the heading above builder.write("\n#"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setResetHeadingLevel("1"); Assert.assertEquals(" SEQ MySequence \\s 1", fieldSeq.getFieldCode()); // Move to the next number builder.write(", #"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setInsertNextNumber(true); Assert.assertEquals(" SEQ MySequence \\n", fieldSeq.getFieldCode()); doc.updateFields(); doc.save(getArtifactsDir() + "Field.SEQ.ResetNumbering.docx");
getResetNumber/setResetNumber | |
public java.lang.String getResetNumber() / public void setResetNumber(java.lang.String value) |
Example:
Shows how to reset numbering of a SEQ field.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Set the current number of the sequence to 100 builder.write("#"); FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setResetNumber("100"); Assert.assertEquals(" SEQ MySequence \\r 100", fieldSeq.getFieldCode()); builder.write(", #"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); // Insert a heading builder.insertBreak(BreakType.PARAGRAPH_BREAK); builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1")); builder.writeln("This level 1 heading will reset MySequence to 1"); builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal")); // Reset the sequence back to 1 when we encounter a heading of a specified level, which in this case is "1", same as the heading above builder.write("\n#"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setResetHeadingLevel("1"); Assert.assertEquals(" SEQ MySequence \\s 1", fieldSeq.getFieldCode()); // Move to the next number builder.write(", #"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setInsertNextNumber(true); Assert.assertEquals(" SEQ MySequence \\n", fieldSeq.getFieldCode()); doc.updateFields(); doc.save(getArtifactsDir() + "Field.SEQ.ResetNumbering.docx");
getResult/setResult | → inherited from Field |
public java.lang.String getResult() / public void setResult(java.lang.String value) |
Example:
Shows how to insert a field into a document by FieldCode.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult dateField.update(); // Display some information from this field // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult()); // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode()); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType()); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object dateField.remove();
getSeparator | → 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; }
getSequenceIdentifier/setSequenceIdentifier | |
public java.lang.String getSequenceIdentifier() / public void setSequenceIdentifier(java.lang.String value) |
Example:
Shows how to reset numbering of a SEQ field.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Set the current number of the sequence to 100 builder.write("#"); FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setResetNumber("100"); Assert.assertEquals(" SEQ MySequence \\r 100", fieldSeq.getFieldCode()); builder.write(", #"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); // Insert a heading builder.insertBreak(BreakType.PARAGRAPH_BREAK); builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1")); builder.writeln("This level 1 heading will reset MySequence to 1"); builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal")); // Reset the sequence back to 1 when we encounter a heading of a specified level, which in this case is "1", same as the heading above builder.write("\n#"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setResetHeadingLevel("1"); Assert.assertEquals(" SEQ MySequence \\s 1", fieldSeq.getFieldCode()); // Move to the next number builder.write(", #"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); fieldSeq.setInsertNextNumber(true); Assert.assertEquals(" SEQ MySequence \\n", fieldSeq.getFieldCode()); doc.updateFields(); doc.save(getArtifactsDir() + "Field.SEQ.ResetNumbering.docx");
Example:
Shows how to populate a TOC field with entries using SEQ fields.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a TOC field that creates a table of contents entry for each paragraph // that contains a SEQ field with a sequence identifier of "MySequence" with the number of the page which contains that field FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); fieldToc.setTableOfFiguresLabel("MySequence"); // This identifier is for a parallel SEQ sequence, // the number that it is at will be displayed in front of the page number of the paragraph with the other sequence, // separated by a sequence separator character also defined below fieldToc.setPrefixedSequenceIdentifier("PrefixSequence"); fieldToc.setSequenceSeparator(">"); Assert.assertEquals(" TOC \\c MySequence \\s PrefixSequence \\d >", fieldToc.getFieldCode()); builder.insertBreak(BreakType.PAGE_BREAK); // Insert a SEQ field to increment the sequence counter of "PrefixSequence" to 1 // Since this paragraph doesn't contain a SEQ field of the "MySequence" sequence, // this will not appear as an entry in the TOC FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("PrefixSequence"); builder.insertParagraph(); Assert.assertEquals(" SEQ PrefixSequence", fieldSeq.getFieldCode()); // Insert two SEQ fields, one for each of the sequences we defined above // The "MySequence" SEQ appears on page 2 and the "PrefixSequence" is at number 1 in this paragraph, // which means that our TOC will display this as an entry with the contents on the left and "1>2" on the right builder.write("First TOC entry, MySequence #"); fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier("MySequence"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.docx");
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:
Shows how to insert a field into a document by FieldCode.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult dateField.update(); // Display some information from this field // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult()); // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode()); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType()); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object dateField.remove();
Method Detail |
---|
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode() |
Example:
Shows how to insert a field into a document by FieldCode.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult dateField.update(); // Display some information from this field // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult()); // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode()); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType()); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object dateField.remove();
Example:
Shows how to get text between field start and field separator (or field end if there is no separator).// Open a document which contains a MERGEFIELD inside an IF field Document doc = new Document(getMyDir() + "Nested fields.docx"); // Get the outer IF field and print its full field code FieldIf fieldIf = (FieldIf) doc.getRange().getFields().get(0); System.out.println("Full field code including child fields:\n\t{fieldIf.GetFieldCode()}"); // All inner nested fields are printed by default Assert.assertEquals(fieldIf.getFieldCode(), fieldIf.getFieldCode(true)); // Print the field code again but this time without the inner MERGEFIELD System.out.println("Field code with nested fields omitted:\n\t{fieldIf.GetFieldCode(false)}");
getFieldCode | → 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).// Open a document which contains a MERGEFIELD inside an IF field Document doc = new Document(getMyDir() + "Nested fields.docx"); // Get the outer IF field and print its full field code FieldIf fieldIf = (FieldIf) doc.getRange().getFields().get(0); System.out.println("Full field code including child fields:\n\t{fieldIf.GetFieldCode()}"); // All inner nested fields are printed by default Assert.assertEquals(fieldIf.getFieldCode(), fieldIf.getFieldCode(true)); // Print the field code again but this time without the inner MERGEFIELD System.out.println("Field code with nested fields omitted:\n\t{fieldIf.GetFieldCode(false)}");
remove | → 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:
Shows how to insert a field into a document by FieldCode.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult dateField.update(); // Display some information from this field // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult()); // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode()); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType()); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object dateField.remove();
unlink | → 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:
Shows how to insert a field into a document by FieldCode.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult dateField.update(); // Display some information from this field // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing Assert.assertEquals(LocalDate.now().format(DateTimeFormatter.ofPattern("M/d/YYYY")), dateField.getResult()); // Display the field code which defines the behavior of the field. This can been seen in Microsoft Word by pressing ALT+F9 Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode()); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType()); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object dateField.remove();
update | → 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 sample - INCLUDEPICTURE.docx", loadOptions); for (Field field : doc.getRange().getFields()) { if (((field.getType()) == (FieldType.FIELD_INCLUDE_PICTURE))) { FieldIncludePicture includePicture = (FieldIncludePicture) field; includePicture.setSourceFullName(getImageDir() + "Transparent background logo.png"); includePicture.update(true); doc.updateFields(); doc.save(getArtifactsDir() + "Field.UpdateFieldIgnoringMergeFormat.docx");