public class FieldAutoTextList
Example:
public void fieldAutoTextList() throws Exception {
Document doc = new Document();
// Create a glossary document and populate it with auto text entries that our auto text list will let us select from
doc.setGlossaryDocument(new GlossaryDocument());
appendAutoTextEntry(doc.getGlossaryDocument(), "AutoText 1", "Contents of AutoText 1");
appendAutoTextEntry(doc.getGlossaryDocument(), "AutoText 2", "Contents of AutoText 2");
appendAutoTextEntry(doc.getGlossaryDocument(), "AutoText 3", "Contents of AutoText 3");
// Insert an auto text list using a document builder and change its properties
DocumentBuilder builder = new DocumentBuilder(doc);
FieldAutoTextList field = (FieldAutoTextList) builder.insertField(FieldType.FIELD_AUTO_TEXT_LIST, true);
field.setEntryName("Right click here to pick an AutoText block"); // This is the text that will be visible in the document
field.setListStyle("Heading 1");
field.setScreenTip("Hover tip text for AutoTextList goes here");
Assert.assertEquals(field.getFieldCode(), " AUTOTEXTLIST \"Right click here to pick an AutoText block\" "
+ "\\s \"Heading 1\" "
+ "\\t \"Hover tip text for AutoTextList goes here\"");
doc.save(getArtifactsDir() + "Field.AutoTextList.dotx");
}
/// <summary>
/// Create an AutoText entry and add it to a glossary document
/// </summary>
private static void appendAutoTextEntry(final GlossaryDocument glossaryDoc, final String name, final String contents) {
// Create building block and set it up as an auto text entry
BuildingBlock buildingBlock = new BuildingBlock(glossaryDoc);
buildingBlock.setName(name);
buildingBlock.setGallery(BuildingBlockGallery.AUTO_TEXT);
buildingBlock.setCategory("General");
buildingBlock.setBehavior(BuildingBlockBehavior.PARAGRAPH);
// Add content to the building block
Section section = new Section(glossaryDoc);
section.appendChild(new Body(glossaryDoc));
section.getBody().appendParagraph(contents);
buildingBlock.appendChild(section);
// Add auto text entry to glossary document
glossaryDoc.appendChild(buildingBlock);
}
Constructor Summary |
---|
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getDisplayResult() | |
Gets the text that represents the displayed field result.
|
||
FieldEnd | getEnd() | |
Gets the node that represents the field end.
|
||
java.lang.String | getEntryName() | |
void | setEntryName(java.lang.Stringvalue) | |
Gets or sets the name of the AutoText entry. | ||
FieldFormat | getFormat() | |
Gets a |
||
boolean | isDirty() | |
void | isDirty(booleanvalue) | |
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. | ||
boolean | isLocked() | |
void | isLocked(booleanvalue) | |
Gets or sets whether the field is locked (should not recalculate its result). | ||
java.lang.String | getListStyle() | |
void | setListStyle(java.lang.Stringvalue) | |
Gets or sets the name of the style on which the list to contain entries is based. | ||
int | getLocaleId() | |
void | setLocaleId(intvalue) | |
Gets or sets the LCID of the field. | ||
java.lang.String | getResult() | |
void | setResult(java.lang.Stringvalue) | |
Gets or sets text that is between the field separator and field end. | ||
java.lang.String | getScreenTip() | |
void | setScreenTip(java.lang.Stringvalue) | |
Gets or sets the text of the ScreenTip to show. | ||
FieldSeparator | getSeparator() | |
Gets the node that represents the field separator. Can be null.
|
||
FieldStart | getStart() | |
Gets the node that represents the start of the field.
|
||
int | getType() | |
Gets the Microsoft Word field type.
The value of the property is FieldType integer constant. |
Method Summary | ||
---|---|---|
java.lang.String | getFieldCode() | |
Returns text between field start and field separator (or field end if there is no separator).
Both field code and field result of child fields are included.
|
||
java.lang.String | getFieldCode(boolean includeChildFieldCodes) | |
Returns text between field start and field separator (or field end if there is no separator).
|
||
Node | remove() | |
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() | |
Performs the field unlink.
|
||
void | update() | |
Performs the field update. Throws if the field is being updated already.
|
||
void | update(boolean ignoreMergeFormat) | |
Performs a field update. Throws if the field is being updated already.
|
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)");
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; }
public java.lang.String getEntryName() / public void setEntryName(java.lang.String value)
Example:
Shows how to use an AutoTextList field to select from a list of AutoText entries.public void fieldAutoTextList() throws Exception { Document doc = new Document(); // Create a glossary document and populate it with auto text entries that our auto text list will let us select from doc.setGlossaryDocument(new GlossaryDocument()); appendAutoTextEntry(doc.getGlossaryDocument(), "AutoText 1", "Contents of AutoText 1"); appendAutoTextEntry(doc.getGlossaryDocument(), "AutoText 2", "Contents of AutoText 2"); appendAutoTextEntry(doc.getGlossaryDocument(), "AutoText 3", "Contents of AutoText 3"); // Insert an auto text list using a document builder and change its properties DocumentBuilder builder = new DocumentBuilder(doc); FieldAutoTextList field = (FieldAutoTextList) builder.insertField(FieldType.FIELD_AUTO_TEXT_LIST, true); field.setEntryName("Right click here to pick an AutoText block"); // This is the text that will be visible in the document field.setListStyle("Heading 1"); field.setScreenTip("Hover tip text for AutoTextList goes here"); Assert.assertEquals(field.getFieldCode(), " AUTOTEXTLIST \"Right click here to pick an AutoText block\" " + "\\s \"Heading 1\" " + "\\t \"Hover tip text for AutoTextList goes here\""); doc.save(getArtifactsDir() + "Field.AutoTextList.dotx"); } /// <summary> /// Create an AutoText entry and add it to a glossary document /// </summary> private static void appendAutoTextEntry(final GlossaryDocument glossaryDoc, final String name, final String contents) { // Create building block and set it up as an auto text entry BuildingBlock buildingBlock = new BuildingBlock(glossaryDoc); buildingBlock.setName(name); buildingBlock.setGallery(BuildingBlockGallery.AUTO_TEXT); buildingBlock.setCategory("General"); buildingBlock.setBehavior(BuildingBlockBehavior.PARAGRAPH); // Add content to the building block Section section = new Section(glossaryDoc); section.appendChild(new Body(glossaryDoc)); section.getBody().appendParagraph(contents); buildingBlock.appendChild(section); // Add auto text entry to glossary document glossaryDoc.appendChild(buildingBlock); }
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");
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);
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();
public java.lang.String getListStyle() / public void setListStyle(java.lang.String value)
Example:
Shows how to use an AutoTextList field to select from a list of AutoText entries.public void fieldAutoTextList() throws Exception { Document doc = new Document(); // Create a glossary document and populate it with auto text entries that our auto text list will let us select from doc.setGlossaryDocument(new GlossaryDocument()); appendAutoTextEntry(doc.getGlossaryDocument(), "AutoText 1", "Contents of AutoText 1"); appendAutoTextEntry(doc.getGlossaryDocument(), "AutoText 2", "Contents of AutoText 2"); appendAutoTextEntry(doc.getGlossaryDocument(), "AutoText 3", "Contents of AutoText 3"); // Insert an auto text list using a document builder and change its properties DocumentBuilder builder = new DocumentBuilder(doc); FieldAutoTextList field = (FieldAutoTextList) builder.insertField(FieldType.FIELD_AUTO_TEXT_LIST, true); field.setEntryName("Right click here to pick an AutoText block"); // This is the text that will be visible in the document field.setListStyle("Heading 1"); field.setScreenTip("Hover tip text for AutoTextList goes here"); Assert.assertEquals(field.getFieldCode(), " AUTOTEXTLIST \"Right click here to pick an AutoText block\" " + "\\s \"Heading 1\" " + "\\t \"Hover tip text for AutoTextList goes here\""); doc.save(getArtifactsDir() + "Field.AutoTextList.dotx"); } /// <summary> /// Create an AutoText entry and add it to a glossary document /// </summary> private static void appendAutoTextEntry(final GlossaryDocument glossaryDoc, final String name, final String contents) { // Create building block and set it up as an auto text entry BuildingBlock buildingBlock = new BuildingBlock(glossaryDoc); buildingBlock.setName(name); buildingBlock.setGallery(BuildingBlockGallery.AUTO_TEXT); buildingBlock.setCategory("General"); buildingBlock.setBehavior(BuildingBlockBehavior.PARAGRAPH); // Add content to the building block Section section = new Section(glossaryDoc); section.appendChild(new Body(glossaryDoc)); section.getBody().appendParagraph(contents); buildingBlock.appendChild(section); // Add auto text entry to glossary document glossaryDoc.appendChild(buildingBlock); }
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);
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();
public java.lang.String getScreenTip() / public void setScreenTip(java.lang.String value)
Example:
Shows how to use an AutoTextList field to select from a list of AutoText entries.public void fieldAutoTextList() throws Exception { Document doc = new Document(); // Create a glossary document and populate it with auto text entries that our auto text list will let us select from doc.setGlossaryDocument(new GlossaryDocument()); appendAutoTextEntry(doc.getGlossaryDocument(), "AutoText 1", "Contents of AutoText 1"); appendAutoTextEntry(doc.getGlossaryDocument(), "AutoText 2", "Contents of AutoText 2"); appendAutoTextEntry(doc.getGlossaryDocument(), "AutoText 3", "Contents of AutoText 3"); // Insert an auto text list using a document builder and change its properties DocumentBuilder builder = new DocumentBuilder(doc); FieldAutoTextList field = (FieldAutoTextList) builder.insertField(FieldType.FIELD_AUTO_TEXT_LIST, true); field.setEntryName("Right click here to pick an AutoText block"); // This is the text that will be visible in the document field.setListStyle("Heading 1"); field.setScreenTip("Hover tip text for AutoTextList goes here"); Assert.assertEquals(field.getFieldCode(), " AUTOTEXTLIST \"Right click here to pick an AutoText block\" " + "\\s \"Heading 1\" " + "\\t \"Hover tip text for AutoTextList goes here\""); doc.save(getArtifactsDir() + "Field.AutoTextList.dotx"); } /// <summary> /// Create an AutoText entry and add it to a glossary document /// </summary> private static void appendAutoTextEntry(final GlossaryDocument glossaryDoc, final String name, final String contents) { // Create building block and set it up as an auto text entry BuildingBlock buildingBlock = new BuildingBlock(glossaryDoc); buildingBlock.setName(name); buildingBlock.setGallery(BuildingBlockGallery.AUTO_TEXT); buildingBlock.setCategory("General"); buildingBlock.setBehavior(BuildingBlockBehavior.PARAGRAPH); // Add content to the building block Section section = new Section(glossaryDoc); section.appendChild(new Body(glossaryDoc)); section.getBody().appendParagraph(contents); buildingBlock.appendChild(section); // Add auto text entry to glossary document glossaryDoc.appendChild(buildingBlock); }
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; }
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; }
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();
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); } } }
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); } } }
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();
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();
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();
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");