java.lang.ObjectField
com.aspose.words.FieldToc
public class FieldToc
Example:
public void fieldToc() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// The table of contents we will insert will accept entries that are only within the scope of this bookmark
builder.startBookmark("MyBookmark");
// Insert a list num field using a document builder
FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true);
// Limit possible TOC entries to only those within the bookmark we name here
fieldToc.setBookmarkName("MyBookmark");
// Normally paragraphs with a "Heading n" style will be the only ones that will be added to a TOC as entries
// We can set this attribute to include other styles, such as "Quote" and "Intense Quote" in this case
fieldToc.setCustomStyles("Quote; 6; Intense Quote; 7");
// Styles are normally separated by a comma (",") but we can use this property to set a custom delimiter
doc.getFieldOptions().setCustomTocStyleSeparator(";");
// Filter out any headings that are outside this range
fieldToc.setHeadingLevelRange("1-3");
// Headings in this range won't display their page number in their TOC entry
fieldToc.setPageNumberOmittingLevelRange("2-5");
fieldToc.setEntrySeparator("-");
fieldToc.setInsertHyperlinks(true);
fieldToc.setHideInWebLayout(false);
fieldToc.setPreserveLineBreaks(true);
fieldToc.setPreserveTabs(true);
fieldToc.setUseParagraphOutlineLevel(false);
insertHeading(builder, "First entry", "Heading 1");
builder.writeln("Paragraph text.");
insertHeading(builder, "Second entry", "Heading 1");
insertHeading(builder, "Third entry", "Quote");
insertHeading(builder, "Fourth entry", "Intense Quote");
// These two headings will have the page numbers omitted because they are within the "2-5" range
insertHeading(builder, "Fifth entry", "Heading 2");
insertHeading(builder, "Sixth entry", "Heading 3");
// This entry will be omitted because "Heading 4" is outside of the "1-3" range we set earlier
insertHeading(builder, "Seventh entry", "Heading 4");
builder.endBookmark("MyBookmark");
builder.writeln("Paragraph text.");
// This entry will be omitted because it is outside the bookmark specified by the TOC
insertHeading(builder, "Eighth entry", "Heading 1");
Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w");
fieldToc.updatePageNumbers();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.FieldTOC.docx");
}
/// <summary>
/// Start a new page and insert a paragraph of a specified style
/// </summary>
@Test(enabled = false)
public void insertHeading(final DocumentBuilder builder, final String captionText, final String styleName) {
builder.insertBreak(BreakType.PAGE_BREAK);
String originalStyle = builder.getParagraphFormat().getStyleName();
builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(styleName));
builder.writeln(captionText);
builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(originalStyle));
}
Constructor Summary |
---|
FieldToc()
|
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getBookmarkName() | |
void | setBookmarkName(java.lang.String value) | |
Gets or sets the name of the bookmark that marks the portion of the document used to build the table. | ||
java.lang.String | getCaptionlessTableOfFiguresLabel() | |
void | setCaptionlessTableOfFiguresLabel(java.lang.String value) | |
Gets or sets the name of the sequence identifier used when building a table of figures that does not include caption's label and number. | ||
java.lang.String | getCustomStyles() | |
void | setCustomStyles(java.lang.String value) | |
Gets or sets a list of styles other than the built-in heading styles to include in the table of contents. | ||
java.lang.String | getDisplayResult() | → inherited from Field |
Gets the text that represents the displayed field result. | ||
FieldEnd | getEnd() | → inherited from Field |
Gets the node that represents the field end. | ||
java.lang.String | getEntryIdentifier() | |
void | setEntryIdentifier(java.lang.String value) | |
Gets or sets a string that should match type identifiers of TC fields being included. | ||
java.lang.String | getEntryLevelRange() | |
void | setEntryLevelRange(java.lang.String value) | |
Gets or sets a range of levels of the table of contents entries to be included. | ||
java.lang.String | getEntrySeparator() | |
void | setEntrySeparator(java.lang.String value) | |
Gets or sets a sequence of characters that separate an entry and its page number. | ||
FieldFormat | getFormat() | → inherited from Field |
Gets a |
||
java.lang.String | getHeadingLevelRange() | |
void | setHeadingLevelRange(java.lang.String value) | |
Gets or sets a range of heading levels to include. | ||
boolean | getHideInWebLayout() | |
void | setHideInWebLayout(boolean value) | |
Gets or sets whether to hide tab leader and page numbers in Web layout view. | ||
boolean | getInsertHyperlinks() | |
void | setInsertHyperlinks(boolean value) | |
Gets or sets whether to make the table of contents entries hyperlinks. | ||
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). | ||
boolean | isPageNumberOmittingLevelRangeSpecified() | |
int | getLocaleId() | → inherited from Field |
void | setLocaleId(int value) | |
Gets or sets the LCID of the field. | ||
java.lang.String | getPageNumberOmittingLevelRange() | |
void | setPageNumberOmittingLevelRange(java.lang.String value) | |
Gets or sets a range of levels of the table of contents entries from which to omits page numbers. | ||
java.lang.String | getPrefixedSequenceIdentifier() | |
void | setPrefixedSequenceIdentifier(java.lang.String value) | |
Gets or sets the identifier of a sequence for which a prefix should be added to the entry's page number. | ||
boolean | getPreserveLineBreaks() | |
void | setPreserveLineBreaks(boolean value) | |
Gets or sets whether to preserve newline characters within table entries. | ||
boolean | getPreserveTabs() | |
void | setPreserveTabs(boolean value) | |
Gets or sets whether to preserve tab entries within table entries. | ||
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 | getSequenceSeparator() | |
void | setSequenceSeparator(java.lang.String value) | |
Gets or sets the character sequence that is used to separate sequence numbers and page numbers. | ||
FieldStart | getStart() | → inherited from Field |
Gets the node that represents the start of the field. | ||
java.lang.String | getTableOfFiguresLabel() | |
void | setTableOfFiguresLabel(java.lang.String value) | |
Gets or sets the name of the sequence identifier used when building a table of figures. | ||
int | getType() | → inherited from Field |
Gets the Microsoft Word field type. The value of the property is FieldType integer constant. | ||
boolean | getUseParagraphOutlineLevel() | |
void | setUseParagraphOutlineLevel(boolean value) | |
Gets or sets whether to use the applied paragraph outline level. |
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. | ||
boolean | updatePageNumbers() | |
Updates the page numbers for items in this table of contents. |
Constructor Detail |
---|
public FieldToc()
Property Getters/Setters Detail |
---|
getBookmarkName/setBookmarkName | |
public java.lang.String getBookmarkName() / public void setBookmarkName(java.lang.String value) |
Example:
Shows how to insert a TOC and populate it with entries based on heading styles.public void fieldToc() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // The table of contents we will insert will accept entries that are only within the scope of this bookmark builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); // Limit possible TOC entries to only those within the bookmark we name here fieldToc.setBookmarkName("MyBookmark"); // Normally paragraphs with a "Heading n" style will be the only ones that will be added to a TOC as entries // We can set this attribute to include other styles, such as "Quote" and "Intense Quote" in this case fieldToc.setCustomStyles("Quote; 6; Intense Quote; 7"); // Styles are normally separated by a comma (",") but we can use this property to set a custom delimiter doc.getFieldOptions().setCustomTocStyleSeparator(";"); // Filter out any headings that are outside this range fieldToc.setHeadingLevelRange("1-3"); // Headings in this range won't display their page number in their TOC entry fieldToc.setPageNumberOmittingLevelRange("2-5"); fieldToc.setEntrySeparator("-"); fieldToc.setInsertHyperlinks(true); fieldToc.setHideInWebLayout(false); fieldToc.setPreserveLineBreaks(true); fieldToc.setPreserveTabs(true); fieldToc.setUseParagraphOutlineLevel(false); insertHeading(builder, "First entry", "Heading 1"); builder.writeln("Paragraph text."); insertHeading(builder, "Second entry", "Heading 1"); insertHeading(builder, "Third entry", "Quote"); insertHeading(builder, "Fourth entry", "Intense Quote"); // These two headings will have the page numbers omitted because they are within the "2-5" range insertHeading(builder, "Fifth entry", "Heading 2"); insertHeading(builder, "Sixth entry", "Heading 3"); // This entry will be omitted because "Heading 4" is outside of the "1-3" range we set earlier insertHeading(builder, "Seventh entry", "Heading 4"); builder.endBookmark("MyBookmark"); builder.writeln("Paragraph text."); // This entry will be omitted because it is outside the bookmark specified by the TOC insertHeading(builder, "Eighth entry", "Heading 1"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w"); fieldToc.updatePageNumbers(); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.docx"); } /// <summary> /// Start a new page and insert a paragraph of a specified style /// </summary> @Test(enabled = false) public void insertHeading(final DocumentBuilder builder, final String captionText, final String styleName) { builder.insertBreak(BreakType.PAGE_BREAK); String originalStyle = builder.getParagraphFormat().getStyleName(); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(styleName)); builder.writeln(captionText); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(originalStyle)); }
getCaptionlessTableOfFiguresLabel/setCaptionlessTableOfFiguresLabel | |
public java.lang.String getCaptionlessTableOfFiguresLabel() / public void setCaptionlessTableOfFiguresLabel(java.lang.String value) |
Example:
Insert a TOC field and build the table with SEQ fields.public void tocSeqPrefix() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Filter by sequence identifier and a prefix sequence identifier, and change sequence separator FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); fieldToc.setTableOfFiguresLabel("MySequence"); fieldToc.setPrefixedSequenceIdentifier("PrefixSequence"); fieldToc.setSequenceSeparator(">"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\c MySequence \\s PrefixSequence \\d >"); builder.insertBreak(BreakType.PAGE_BREAK); // Add two SEQ fields in one paragraph, setting the TOC's sequence and prefix sequence as their sequence identifiers FieldSeq fieldSeq = insertSeqField(builder, "PrefixSequence ", "", "PrefixSequence"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ PrefixSequence"); fieldSeq = insertSeqField(builder, ", MySequence ", "\n", "MySequence"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence"); insertSeqField(builder, "PrefixSequence ", "", "PrefixSequence"); insertSeqField(builder, ", MySequence ", "\n", "MySequence"); // If the sqeuence identifier doesn't match that of the TOC, the entry won't be included insertSeqField(builder, "PrefixSequence ", "", "PrefixSequence"); fieldSeq = insertSeqField(builder, ", MySequence ", "", "OtherSequence"); builder.writeln(" This text, from a different sequence, won't be included in the same TOC as the one above."); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ OtherSequence"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.Prefix.docx"); } public void tocSeqNumbering() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Filter by sequence identifier and a prefix sequence identifier, and change sequence separator FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); fieldToc.setTableOfFiguresLabel("MySequence"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\c MySequence"); builder.insertBreak(BreakType.PAGE_BREAK); // Set the current number of the sequence to 100 FieldSeq fieldSeq = insertSeqField(builder, "MySequence ", "\n", "MySequence"); fieldSeq.setResetNumber("100"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence \\r 100"); insertSeqField(builder, "MySequence ", "\n", "MySequence"); // Insert a heading builder.insertBreak(BreakType.PARAGRAPH_BREAK); builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1")); builder.writeln("My heading"); builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal")); // Reset sequence when we encounter a heading, resetting the sequence back to 1 fieldSeq = insertSeqField(builder, "MySequence ", "\n", "MySequence"); fieldSeq.setResetHeadingLevel("1"); Assert.assertEquals(" SEQ MySequence \\s 1", fieldSeq.getFieldCode()); // Move to the next number fieldSeq = insertSeqField(builder, "MySequence ", "\n", "MySequence"); fieldSeq.setInsertNextNumber(true); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence \\n"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.ResetNumbering.docx"); } public void tocSeqBookmark() throws Exception { 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(fieldToc.getFieldCode(), " TOC \\c MySequence \\b TOCBookmark"); insertSeqField(builder, "MySequence ", "", "MySequence"); builder.writeln(" This text won't show up in the TOC because it is outside of the bookmark."); builder.startBookmark("TOCBookmark"); insertSeqField(builder, "MySequence ", "", "MySequence"); builder.writeln(" This text will show up in the TOC next to the entry for the above caption."); insertSeqField(builder, "OtherSequence ", "", "OtherSequence"); builder.writeln(" This text, from a different sequence, won't be included in the same TOC as the one above."); // 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 = insertSeqField(builder, " MySequence ", "\n", "MySequence"); fieldSeq.setBookmarkName("SEQBookmark"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence SEQBookmark"); // Add bookmark to reference builder.insertBreak(BreakType.PAGE_BREAK); builder.startBookmark("SEQBookmark"); insertSeqField(builder, " MySequence ", "", "MySequence"); builder.writeln(" Text inside SEQBookmark."); builder.endBookmark("SEQBookmark"); builder.endBookmark("TOCBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.Bookmark.docx"); } /// <summary> /// Insert a sequence field with preceding text and a specified sequence identifier /// </summary> @Test(enabled = false) public FieldSeq insertSeqField(final DocumentBuilder builder, final String textBefore, final String textAfter, final String sequenceIdentifier) throws Exception { builder.write(textBefore); FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier(sequenceIdentifier); builder.write(textAfter); return fieldSeq; }
getCustomStyles/setCustomStyles | |
public java.lang.String getCustomStyles() / public void setCustomStyles(java.lang.String value) |
Example:
Shows how to insert a TOC and populate it with entries based on heading styles.public void fieldToc() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // The table of contents we will insert will accept entries that are only within the scope of this bookmark builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); // Limit possible TOC entries to only those within the bookmark we name here fieldToc.setBookmarkName("MyBookmark"); // Normally paragraphs with a "Heading n" style will be the only ones that will be added to a TOC as entries // We can set this attribute to include other styles, such as "Quote" and "Intense Quote" in this case fieldToc.setCustomStyles("Quote; 6; Intense Quote; 7"); // Styles are normally separated by a comma (",") but we can use this property to set a custom delimiter doc.getFieldOptions().setCustomTocStyleSeparator(";"); // Filter out any headings that are outside this range fieldToc.setHeadingLevelRange("1-3"); // Headings in this range won't display their page number in their TOC entry fieldToc.setPageNumberOmittingLevelRange("2-5"); fieldToc.setEntrySeparator("-"); fieldToc.setInsertHyperlinks(true); fieldToc.setHideInWebLayout(false); fieldToc.setPreserveLineBreaks(true); fieldToc.setPreserveTabs(true); fieldToc.setUseParagraphOutlineLevel(false); insertHeading(builder, "First entry", "Heading 1"); builder.writeln("Paragraph text."); insertHeading(builder, "Second entry", "Heading 1"); insertHeading(builder, "Third entry", "Quote"); insertHeading(builder, "Fourth entry", "Intense Quote"); // These two headings will have the page numbers omitted because they are within the "2-5" range insertHeading(builder, "Fifth entry", "Heading 2"); insertHeading(builder, "Sixth entry", "Heading 3"); // This entry will be omitted because "Heading 4" is outside of the "1-3" range we set earlier insertHeading(builder, "Seventh entry", "Heading 4"); builder.endBookmark("MyBookmark"); builder.writeln("Paragraph text."); // This entry will be omitted because it is outside the bookmark specified by the TOC insertHeading(builder, "Eighth entry", "Heading 1"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w"); fieldToc.updatePageNumbers(); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.docx"); } /// <summary> /// Start a new page and insert a paragraph of a specified style /// </summary> @Test(enabled = false) public void insertHeading(final DocumentBuilder builder, final String captionText, final String styleName) { builder.insertBreak(BreakType.PAGE_BREAK); String originalStyle = builder.getParagraphFormat().getStyleName(); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(styleName)); builder.writeln(captionText); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(originalStyle)); }
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; }
getEntryIdentifier/setEntryIdentifier | |
public java.lang.String getEntryIdentifier() / public void setEntryIdentifier(java.lang.String value) |
Example:
Shows how to insert a TOC field and filter which TC fields end up as entries.public void fieldTocEntryIdentifier() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); fieldToc.setEntryIdentifier("A"); fieldToc.setEntryLevelRange("1-3"); builder.insertBreak(BreakType.PAGE_BREAK); // These two entries will appear in the table insertTocEntry(builder, "TC field 1", "A", "1"); insertTocEntry(builder, "TC field 2", "A", "2"); // These two entries will be omitted because of an incorrect type identifier insertTocEntry(builder, "TC field 3", "B", "1"); // ...and an out-of-range entry level insertTocEntry(builder, "TC field 4", "A", "5"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\f A \\l 1-3"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.TC.docx"); } /// <summary> /// Insert a table of contents entry via a document builder /// </summary> @Test(enabled = false) public void insertTocEntry(final DocumentBuilder builder, final String text, final String typeIdentifier, final String entryLevel) throws Exception { FieldTC fieldTc = (FieldTC) builder.insertField(FieldType.FIELD_TOC_ENTRY, true); fieldTc.setOmitPageNumber(true); fieldTc.setText(text); fieldTc.setTypeIdentifier(typeIdentifier); fieldTc.setEntryLevel(entryLevel); }
getEntryLevelRange/setEntryLevelRange | |
public java.lang.String getEntryLevelRange() / public void setEntryLevelRange(java.lang.String value) |
Example:
Shows how to insert a TOC field and filter which TC fields end up as entries.public void fieldTocEntryIdentifier() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); fieldToc.setEntryIdentifier("A"); fieldToc.setEntryLevelRange("1-3"); builder.insertBreak(BreakType.PAGE_BREAK); // These two entries will appear in the table insertTocEntry(builder, "TC field 1", "A", "1"); insertTocEntry(builder, "TC field 2", "A", "2"); // These two entries will be omitted because of an incorrect type identifier insertTocEntry(builder, "TC field 3", "B", "1"); // ...and an out-of-range entry level insertTocEntry(builder, "TC field 4", "A", "5"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\f A \\l 1-3"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.TC.docx"); } /// <summary> /// Insert a table of contents entry via a document builder /// </summary> @Test(enabled = false) public void insertTocEntry(final DocumentBuilder builder, final String text, final String typeIdentifier, final String entryLevel) throws Exception { FieldTC fieldTc = (FieldTC) builder.insertField(FieldType.FIELD_TOC_ENTRY, true); fieldTc.setOmitPageNumber(true); fieldTc.setText(text); fieldTc.setTypeIdentifier(typeIdentifier); fieldTc.setEntryLevel(entryLevel); }
getEntrySeparator/setEntrySeparator | |
public java.lang.String getEntrySeparator() / public void setEntrySeparator(java.lang.String value) |
Example:
Shows how to insert a TOC and populate it with entries based on heading styles.public void fieldToc() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // The table of contents we will insert will accept entries that are only within the scope of this bookmark builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); // Limit possible TOC entries to only those within the bookmark we name here fieldToc.setBookmarkName("MyBookmark"); // Normally paragraphs with a "Heading n" style will be the only ones that will be added to a TOC as entries // We can set this attribute to include other styles, such as "Quote" and "Intense Quote" in this case fieldToc.setCustomStyles("Quote; 6; Intense Quote; 7"); // Styles are normally separated by a comma (",") but we can use this property to set a custom delimiter doc.getFieldOptions().setCustomTocStyleSeparator(";"); // Filter out any headings that are outside this range fieldToc.setHeadingLevelRange("1-3"); // Headings in this range won't display their page number in their TOC entry fieldToc.setPageNumberOmittingLevelRange("2-5"); fieldToc.setEntrySeparator("-"); fieldToc.setInsertHyperlinks(true); fieldToc.setHideInWebLayout(false); fieldToc.setPreserveLineBreaks(true); fieldToc.setPreserveTabs(true); fieldToc.setUseParagraphOutlineLevel(false); insertHeading(builder, "First entry", "Heading 1"); builder.writeln("Paragraph text."); insertHeading(builder, "Second entry", "Heading 1"); insertHeading(builder, "Third entry", "Quote"); insertHeading(builder, "Fourth entry", "Intense Quote"); // These two headings will have the page numbers omitted because they are within the "2-5" range insertHeading(builder, "Fifth entry", "Heading 2"); insertHeading(builder, "Sixth entry", "Heading 3"); // This entry will be omitted because "Heading 4" is outside of the "1-3" range we set earlier insertHeading(builder, "Seventh entry", "Heading 4"); builder.endBookmark("MyBookmark"); builder.writeln("Paragraph text."); // This entry will be omitted because it is outside the bookmark specified by the TOC insertHeading(builder, "Eighth entry", "Heading 1"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w"); fieldToc.updatePageNumbers(); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.docx"); } /// <summary> /// Start a new page and insert a paragraph of a specified style /// </summary> @Test(enabled = false) public void insertHeading(final DocumentBuilder builder, final String captionText, final String styleName) { builder.insertBreak(BreakType.PAGE_BREAK); String originalStyle = builder.getParagraphFormat().getStyleName(); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(styleName)); builder.writeln(captionText); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(originalStyle)); }
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");
getHeadingLevelRange/setHeadingLevelRange | |
public java.lang.String getHeadingLevelRange() / public void setHeadingLevelRange(java.lang.String value) |
Example:
Shows how to insert a TOC and populate it with entries based on heading styles.public void fieldToc() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // The table of contents we will insert will accept entries that are only within the scope of this bookmark builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); // Limit possible TOC entries to only those within the bookmark we name here fieldToc.setBookmarkName("MyBookmark"); // Normally paragraphs with a "Heading n" style will be the only ones that will be added to a TOC as entries // We can set this attribute to include other styles, such as "Quote" and "Intense Quote" in this case fieldToc.setCustomStyles("Quote; 6; Intense Quote; 7"); // Styles are normally separated by a comma (",") but we can use this property to set a custom delimiter doc.getFieldOptions().setCustomTocStyleSeparator(";"); // Filter out any headings that are outside this range fieldToc.setHeadingLevelRange("1-3"); // Headings in this range won't display their page number in their TOC entry fieldToc.setPageNumberOmittingLevelRange("2-5"); fieldToc.setEntrySeparator("-"); fieldToc.setInsertHyperlinks(true); fieldToc.setHideInWebLayout(false); fieldToc.setPreserveLineBreaks(true); fieldToc.setPreserveTabs(true); fieldToc.setUseParagraphOutlineLevel(false); insertHeading(builder, "First entry", "Heading 1"); builder.writeln("Paragraph text."); insertHeading(builder, "Second entry", "Heading 1"); insertHeading(builder, "Third entry", "Quote"); insertHeading(builder, "Fourth entry", "Intense Quote"); // These two headings will have the page numbers omitted because they are within the "2-5" range insertHeading(builder, "Fifth entry", "Heading 2"); insertHeading(builder, "Sixth entry", "Heading 3"); // This entry will be omitted because "Heading 4" is outside of the "1-3" range we set earlier insertHeading(builder, "Seventh entry", "Heading 4"); builder.endBookmark("MyBookmark"); builder.writeln("Paragraph text."); // This entry will be omitted because it is outside the bookmark specified by the TOC insertHeading(builder, "Eighth entry", "Heading 1"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w"); fieldToc.updatePageNumbers(); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.docx"); } /// <summary> /// Start a new page and insert a paragraph of a specified style /// </summary> @Test(enabled = false) public void insertHeading(final DocumentBuilder builder, final String captionText, final String styleName) { builder.insertBreak(BreakType.PAGE_BREAK); String originalStyle = builder.getParagraphFormat().getStyleName(); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(styleName)); builder.writeln(captionText); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(originalStyle)); }
getHideInWebLayout/setHideInWebLayout | |
public boolean getHideInWebLayout() / public void setHideInWebLayout(boolean value) |
Example:
Shows how to insert a TOC and populate it with entries based on heading styles.public void fieldToc() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // The table of contents we will insert will accept entries that are only within the scope of this bookmark builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); // Limit possible TOC entries to only those within the bookmark we name here fieldToc.setBookmarkName("MyBookmark"); // Normally paragraphs with a "Heading n" style will be the only ones that will be added to a TOC as entries // We can set this attribute to include other styles, such as "Quote" and "Intense Quote" in this case fieldToc.setCustomStyles("Quote; 6; Intense Quote; 7"); // Styles are normally separated by a comma (",") but we can use this property to set a custom delimiter doc.getFieldOptions().setCustomTocStyleSeparator(";"); // Filter out any headings that are outside this range fieldToc.setHeadingLevelRange("1-3"); // Headings in this range won't display their page number in their TOC entry fieldToc.setPageNumberOmittingLevelRange("2-5"); fieldToc.setEntrySeparator("-"); fieldToc.setInsertHyperlinks(true); fieldToc.setHideInWebLayout(false); fieldToc.setPreserveLineBreaks(true); fieldToc.setPreserveTabs(true); fieldToc.setUseParagraphOutlineLevel(false); insertHeading(builder, "First entry", "Heading 1"); builder.writeln("Paragraph text."); insertHeading(builder, "Second entry", "Heading 1"); insertHeading(builder, "Third entry", "Quote"); insertHeading(builder, "Fourth entry", "Intense Quote"); // These two headings will have the page numbers omitted because they are within the "2-5" range insertHeading(builder, "Fifth entry", "Heading 2"); insertHeading(builder, "Sixth entry", "Heading 3"); // This entry will be omitted because "Heading 4" is outside of the "1-3" range we set earlier insertHeading(builder, "Seventh entry", "Heading 4"); builder.endBookmark("MyBookmark"); builder.writeln("Paragraph text."); // This entry will be omitted because it is outside the bookmark specified by the TOC insertHeading(builder, "Eighth entry", "Heading 1"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w"); fieldToc.updatePageNumbers(); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.docx"); } /// <summary> /// Start a new page and insert a paragraph of a specified style /// </summary> @Test(enabled = false) public void insertHeading(final DocumentBuilder builder, final String captionText, final String styleName) { builder.insertBreak(BreakType.PAGE_BREAK); String originalStyle = builder.getParagraphFormat().getStyleName(); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(styleName)); builder.writeln(captionText); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(originalStyle)); }
getInsertHyperlinks/setInsertHyperlinks | |
public boolean getInsertHyperlinks() / public void setInsertHyperlinks(boolean value) |
Example:
Shows how to insert a TOC and populate it with entries based on heading styles.public void fieldToc() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // The table of contents we will insert will accept entries that are only within the scope of this bookmark builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); // Limit possible TOC entries to only those within the bookmark we name here fieldToc.setBookmarkName("MyBookmark"); // Normally paragraphs with a "Heading n" style will be the only ones that will be added to a TOC as entries // We can set this attribute to include other styles, such as "Quote" and "Intense Quote" in this case fieldToc.setCustomStyles("Quote; 6; Intense Quote; 7"); // Styles are normally separated by a comma (",") but we can use this property to set a custom delimiter doc.getFieldOptions().setCustomTocStyleSeparator(";"); // Filter out any headings that are outside this range fieldToc.setHeadingLevelRange("1-3"); // Headings in this range won't display their page number in their TOC entry fieldToc.setPageNumberOmittingLevelRange("2-5"); fieldToc.setEntrySeparator("-"); fieldToc.setInsertHyperlinks(true); fieldToc.setHideInWebLayout(false); fieldToc.setPreserveLineBreaks(true); fieldToc.setPreserveTabs(true); fieldToc.setUseParagraphOutlineLevel(false); insertHeading(builder, "First entry", "Heading 1"); builder.writeln("Paragraph text."); insertHeading(builder, "Second entry", "Heading 1"); insertHeading(builder, "Third entry", "Quote"); insertHeading(builder, "Fourth entry", "Intense Quote"); // These two headings will have the page numbers omitted because they are within the "2-5" range insertHeading(builder, "Fifth entry", "Heading 2"); insertHeading(builder, "Sixth entry", "Heading 3"); // This entry will be omitted because "Heading 4" is outside of the "1-3" range we set earlier insertHeading(builder, "Seventh entry", "Heading 4"); builder.endBookmark("MyBookmark"); builder.writeln("Paragraph text."); // This entry will be omitted because it is outside the bookmark specified by the TOC insertHeading(builder, "Eighth entry", "Heading 1"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w"); fieldToc.updatePageNumbers(); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.docx"); } /// <summary> /// Start a new page and insert a paragraph of a specified style /// </summary> @Test(enabled = false) public void insertHeading(final DocumentBuilder builder, final String captionText, final String styleName) { builder.insertBreak(BreakType.PAGE_BREAK); String originalStyle = builder.getParagraphFormat().getStyleName(); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(styleName)); builder.writeln(captionText); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(originalStyle)); }
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();
isPageNumberOmittingLevelRangeSpecified | |
public boolean isPageNumberOmittingLevelRangeSpecified() |
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);
getPageNumberOmittingLevelRange/setPageNumberOmittingLevelRange | |
public java.lang.String getPageNumberOmittingLevelRange() / public void setPageNumberOmittingLevelRange(java.lang.String value) |
Example:
Shows how to insert a TOC and populate it with entries based on heading styles.public void fieldToc() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // The table of contents we will insert will accept entries that are only within the scope of this bookmark builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); // Limit possible TOC entries to only those within the bookmark we name here fieldToc.setBookmarkName("MyBookmark"); // Normally paragraphs with a "Heading n" style will be the only ones that will be added to a TOC as entries // We can set this attribute to include other styles, such as "Quote" and "Intense Quote" in this case fieldToc.setCustomStyles("Quote; 6; Intense Quote; 7"); // Styles are normally separated by a comma (",") but we can use this property to set a custom delimiter doc.getFieldOptions().setCustomTocStyleSeparator(";"); // Filter out any headings that are outside this range fieldToc.setHeadingLevelRange("1-3"); // Headings in this range won't display their page number in their TOC entry fieldToc.setPageNumberOmittingLevelRange("2-5"); fieldToc.setEntrySeparator("-"); fieldToc.setInsertHyperlinks(true); fieldToc.setHideInWebLayout(false); fieldToc.setPreserveLineBreaks(true); fieldToc.setPreserveTabs(true); fieldToc.setUseParagraphOutlineLevel(false); insertHeading(builder, "First entry", "Heading 1"); builder.writeln("Paragraph text."); insertHeading(builder, "Second entry", "Heading 1"); insertHeading(builder, "Third entry", "Quote"); insertHeading(builder, "Fourth entry", "Intense Quote"); // These two headings will have the page numbers omitted because they are within the "2-5" range insertHeading(builder, "Fifth entry", "Heading 2"); insertHeading(builder, "Sixth entry", "Heading 3"); // This entry will be omitted because "Heading 4" is outside of the "1-3" range we set earlier insertHeading(builder, "Seventh entry", "Heading 4"); builder.endBookmark("MyBookmark"); builder.writeln("Paragraph text."); // This entry will be omitted because it is outside the bookmark specified by the TOC insertHeading(builder, "Eighth entry", "Heading 1"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w"); fieldToc.updatePageNumbers(); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.docx"); } /// <summary> /// Start a new page and insert a paragraph of a specified style /// </summary> @Test(enabled = false) public void insertHeading(final DocumentBuilder builder, final String captionText, final String styleName) { builder.insertBreak(BreakType.PAGE_BREAK); String originalStyle = builder.getParagraphFormat().getStyleName(); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(styleName)); builder.writeln(captionText); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(originalStyle)); }
getPrefixedSequenceIdentifier/setPrefixedSequenceIdentifier | |
public java.lang.String getPrefixedSequenceIdentifier() / public void setPrefixedSequenceIdentifier(java.lang.String value) |
Example:
Insert a TOC field and build the table with SEQ fields.public void tocSeqPrefix() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Filter by sequence identifier and a prefix sequence identifier, and change sequence separator FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); fieldToc.setTableOfFiguresLabel("MySequence"); fieldToc.setPrefixedSequenceIdentifier("PrefixSequence"); fieldToc.setSequenceSeparator(">"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\c MySequence \\s PrefixSequence \\d >"); builder.insertBreak(BreakType.PAGE_BREAK); // Add two SEQ fields in one paragraph, setting the TOC's sequence and prefix sequence as their sequence identifiers FieldSeq fieldSeq = insertSeqField(builder, "PrefixSequence ", "", "PrefixSequence"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ PrefixSequence"); fieldSeq = insertSeqField(builder, ", MySequence ", "\n", "MySequence"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence"); insertSeqField(builder, "PrefixSequence ", "", "PrefixSequence"); insertSeqField(builder, ", MySequence ", "\n", "MySequence"); // If the sqeuence identifier doesn't match that of the TOC, the entry won't be included insertSeqField(builder, "PrefixSequence ", "", "PrefixSequence"); fieldSeq = insertSeqField(builder, ", MySequence ", "", "OtherSequence"); builder.writeln(" This text, from a different sequence, won't be included in the same TOC as the one above."); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ OtherSequence"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.Prefix.docx"); } public void tocSeqNumbering() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Filter by sequence identifier and a prefix sequence identifier, and change sequence separator FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); fieldToc.setTableOfFiguresLabel("MySequence"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\c MySequence"); builder.insertBreak(BreakType.PAGE_BREAK); // Set the current number of the sequence to 100 FieldSeq fieldSeq = insertSeqField(builder, "MySequence ", "\n", "MySequence"); fieldSeq.setResetNumber("100"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence \\r 100"); insertSeqField(builder, "MySequence ", "\n", "MySequence"); // Insert a heading builder.insertBreak(BreakType.PARAGRAPH_BREAK); builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1")); builder.writeln("My heading"); builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal")); // Reset sequence when we encounter a heading, resetting the sequence back to 1 fieldSeq = insertSeqField(builder, "MySequence ", "\n", "MySequence"); fieldSeq.setResetHeadingLevel("1"); Assert.assertEquals(" SEQ MySequence \\s 1", fieldSeq.getFieldCode()); // Move to the next number fieldSeq = insertSeqField(builder, "MySequence ", "\n", "MySequence"); fieldSeq.setInsertNextNumber(true); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence \\n"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.ResetNumbering.docx"); } public void tocSeqBookmark() throws Exception { 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(fieldToc.getFieldCode(), " TOC \\c MySequence \\b TOCBookmark"); insertSeqField(builder, "MySequence ", "", "MySequence"); builder.writeln(" This text won't show up in the TOC because it is outside of the bookmark."); builder.startBookmark("TOCBookmark"); insertSeqField(builder, "MySequence ", "", "MySequence"); builder.writeln(" This text will show up in the TOC next to the entry for the above caption."); insertSeqField(builder, "OtherSequence ", "", "OtherSequence"); builder.writeln(" This text, from a different sequence, won't be included in the same TOC as the one above."); // 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 = insertSeqField(builder, " MySequence ", "\n", "MySequence"); fieldSeq.setBookmarkName("SEQBookmark"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence SEQBookmark"); // Add bookmark to reference builder.insertBreak(BreakType.PAGE_BREAK); builder.startBookmark("SEQBookmark"); insertSeqField(builder, " MySequence ", "", "MySequence"); builder.writeln(" Text inside SEQBookmark."); builder.endBookmark("SEQBookmark"); builder.endBookmark("TOCBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.Bookmark.docx"); } /// <summary> /// Insert a sequence field with preceding text and a specified sequence identifier /// </summary> @Test(enabled = false) public FieldSeq insertSeqField(final DocumentBuilder builder, final String textBefore, final String textAfter, final String sequenceIdentifier) throws Exception { builder.write(textBefore); FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier(sequenceIdentifier); builder.write(textAfter); return fieldSeq; }
getPreserveLineBreaks/setPreserveLineBreaks | |
public boolean getPreserveLineBreaks() / public void setPreserveLineBreaks(boolean value) |
Example:
Shows how to insert a TOC and populate it with entries based on heading styles.public void fieldToc() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // The table of contents we will insert will accept entries that are only within the scope of this bookmark builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); // Limit possible TOC entries to only those within the bookmark we name here fieldToc.setBookmarkName("MyBookmark"); // Normally paragraphs with a "Heading n" style will be the only ones that will be added to a TOC as entries // We can set this attribute to include other styles, such as "Quote" and "Intense Quote" in this case fieldToc.setCustomStyles("Quote; 6; Intense Quote; 7"); // Styles are normally separated by a comma (",") but we can use this property to set a custom delimiter doc.getFieldOptions().setCustomTocStyleSeparator(";"); // Filter out any headings that are outside this range fieldToc.setHeadingLevelRange("1-3"); // Headings in this range won't display their page number in their TOC entry fieldToc.setPageNumberOmittingLevelRange("2-5"); fieldToc.setEntrySeparator("-"); fieldToc.setInsertHyperlinks(true); fieldToc.setHideInWebLayout(false); fieldToc.setPreserveLineBreaks(true); fieldToc.setPreserveTabs(true); fieldToc.setUseParagraphOutlineLevel(false); insertHeading(builder, "First entry", "Heading 1"); builder.writeln("Paragraph text."); insertHeading(builder, "Second entry", "Heading 1"); insertHeading(builder, "Third entry", "Quote"); insertHeading(builder, "Fourth entry", "Intense Quote"); // These two headings will have the page numbers omitted because they are within the "2-5" range insertHeading(builder, "Fifth entry", "Heading 2"); insertHeading(builder, "Sixth entry", "Heading 3"); // This entry will be omitted because "Heading 4" is outside of the "1-3" range we set earlier insertHeading(builder, "Seventh entry", "Heading 4"); builder.endBookmark("MyBookmark"); builder.writeln("Paragraph text."); // This entry will be omitted because it is outside the bookmark specified by the TOC insertHeading(builder, "Eighth entry", "Heading 1"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w"); fieldToc.updatePageNumbers(); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.docx"); } /// <summary> /// Start a new page and insert a paragraph of a specified style /// </summary> @Test(enabled = false) public void insertHeading(final DocumentBuilder builder, final String captionText, final String styleName) { builder.insertBreak(BreakType.PAGE_BREAK); String originalStyle = builder.getParagraphFormat().getStyleName(); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(styleName)); builder.writeln(captionText); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(originalStyle)); }
getPreserveTabs/setPreserveTabs | |
public boolean getPreserveTabs() / public void setPreserveTabs(boolean value) |
Example:
Shows how to insert a TOC and populate it with entries based on heading styles.public void fieldToc() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // The table of contents we will insert will accept entries that are only within the scope of this bookmark builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); // Limit possible TOC entries to only those within the bookmark we name here fieldToc.setBookmarkName("MyBookmark"); // Normally paragraphs with a "Heading n" style will be the only ones that will be added to a TOC as entries // We can set this attribute to include other styles, such as "Quote" and "Intense Quote" in this case fieldToc.setCustomStyles("Quote; 6; Intense Quote; 7"); // Styles are normally separated by a comma (",") but we can use this property to set a custom delimiter doc.getFieldOptions().setCustomTocStyleSeparator(";"); // Filter out any headings that are outside this range fieldToc.setHeadingLevelRange("1-3"); // Headings in this range won't display their page number in their TOC entry fieldToc.setPageNumberOmittingLevelRange("2-5"); fieldToc.setEntrySeparator("-"); fieldToc.setInsertHyperlinks(true); fieldToc.setHideInWebLayout(false); fieldToc.setPreserveLineBreaks(true); fieldToc.setPreserveTabs(true); fieldToc.setUseParagraphOutlineLevel(false); insertHeading(builder, "First entry", "Heading 1"); builder.writeln("Paragraph text."); insertHeading(builder, "Second entry", "Heading 1"); insertHeading(builder, "Third entry", "Quote"); insertHeading(builder, "Fourth entry", "Intense Quote"); // These two headings will have the page numbers omitted because they are within the "2-5" range insertHeading(builder, "Fifth entry", "Heading 2"); insertHeading(builder, "Sixth entry", "Heading 3"); // This entry will be omitted because "Heading 4" is outside of the "1-3" range we set earlier insertHeading(builder, "Seventh entry", "Heading 4"); builder.endBookmark("MyBookmark"); builder.writeln("Paragraph text."); // This entry will be omitted because it is outside the bookmark specified by the TOC insertHeading(builder, "Eighth entry", "Heading 1"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w"); fieldToc.updatePageNumbers(); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.docx"); } /// <summary> /// Start a new page and insert a paragraph of a specified style /// </summary> @Test(enabled = false) public void insertHeading(final DocumentBuilder builder, final String captionText, final String styleName) { builder.insertBreak(BreakType.PAGE_BREAK); String originalStyle = builder.getParagraphFormat().getStyleName(); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(styleName)); builder.writeln(captionText); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(originalStyle)); }
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; }
getSequenceSeparator/setSequenceSeparator | |
public java.lang.String getSequenceSeparator() / public void setSequenceSeparator(java.lang.String value) |
Example:
Insert a TOC field and build the table with SEQ fields.public void tocSeqPrefix() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Filter by sequence identifier and a prefix sequence identifier, and change sequence separator FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); fieldToc.setTableOfFiguresLabel("MySequence"); fieldToc.setPrefixedSequenceIdentifier("PrefixSequence"); fieldToc.setSequenceSeparator(">"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\c MySequence \\s PrefixSequence \\d >"); builder.insertBreak(BreakType.PAGE_BREAK); // Add two SEQ fields in one paragraph, setting the TOC's sequence and prefix sequence as their sequence identifiers FieldSeq fieldSeq = insertSeqField(builder, "PrefixSequence ", "", "PrefixSequence"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ PrefixSequence"); fieldSeq = insertSeqField(builder, ", MySequence ", "\n", "MySequence"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence"); insertSeqField(builder, "PrefixSequence ", "", "PrefixSequence"); insertSeqField(builder, ", MySequence ", "\n", "MySequence"); // If the sqeuence identifier doesn't match that of the TOC, the entry won't be included insertSeqField(builder, "PrefixSequence ", "", "PrefixSequence"); fieldSeq = insertSeqField(builder, ", MySequence ", "", "OtherSequence"); builder.writeln(" This text, from a different sequence, won't be included in the same TOC as the one above."); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ OtherSequence"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.Prefix.docx"); } public void tocSeqNumbering() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Filter by sequence identifier and a prefix sequence identifier, and change sequence separator FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); fieldToc.setTableOfFiguresLabel("MySequence"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\c MySequence"); builder.insertBreak(BreakType.PAGE_BREAK); // Set the current number of the sequence to 100 FieldSeq fieldSeq = insertSeqField(builder, "MySequence ", "\n", "MySequence"); fieldSeq.setResetNumber("100"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence \\r 100"); insertSeqField(builder, "MySequence ", "\n", "MySequence"); // Insert a heading builder.insertBreak(BreakType.PARAGRAPH_BREAK); builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1")); builder.writeln("My heading"); builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal")); // Reset sequence when we encounter a heading, resetting the sequence back to 1 fieldSeq = insertSeqField(builder, "MySequence ", "\n", "MySequence"); fieldSeq.setResetHeadingLevel("1"); Assert.assertEquals(" SEQ MySequence \\s 1", fieldSeq.getFieldCode()); // Move to the next number fieldSeq = insertSeqField(builder, "MySequence ", "\n", "MySequence"); fieldSeq.setInsertNextNumber(true); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence \\n"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.ResetNumbering.docx"); } public void tocSeqBookmark() throws Exception { 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(fieldToc.getFieldCode(), " TOC \\c MySequence \\b TOCBookmark"); insertSeqField(builder, "MySequence ", "", "MySequence"); builder.writeln(" This text won't show up in the TOC because it is outside of the bookmark."); builder.startBookmark("TOCBookmark"); insertSeqField(builder, "MySequence ", "", "MySequence"); builder.writeln(" This text will show up in the TOC next to the entry for the above caption."); insertSeqField(builder, "OtherSequence ", "", "OtherSequence"); builder.writeln(" This text, from a different sequence, won't be included in the same TOC as the one above."); // 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 = insertSeqField(builder, " MySequence ", "\n", "MySequence"); fieldSeq.setBookmarkName("SEQBookmark"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence SEQBookmark"); // Add bookmark to reference builder.insertBreak(BreakType.PAGE_BREAK); builder.startBookmark("SEQBookmark"); insertSeqField(builder, " MySequence ", "", "MySequence"); builder.writeln(" Text inside SEQBookmark."); builder.endBookmark("SEQBookmark"); builder.endBookmark("TOCBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.Bookmark.docx"); } /// <summary> /// Insert a sequence field with preceding text and a specified sequence identifier /// </summary> @Test(enabled = false) public FieldSeq insertSeqField(final DocumentBuilder builder, final String textBefore, final String textAfter, final String sequenceIdentifier) throws Exception { builder.write(textBefore); FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier(sequenceIdentifier); builder.write(textAfter); return fieldSeq; }
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; }
getTableOfFiguresLabel/setTableOfFiguresLabel | |
public java.lang.String getTableOfFiguresLabel() / public void setTableOfFiguresLabel(java.lang.String value) |
Example:
Insert a TOC field and build the table with SEQ fields.public void tocSeqPrefix() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Filter by sequence identifier and a prefix sequence identifier, and change sequence separator FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); fieldToc.setTableOfFiguresLabel("MySequence"); fieldToc.setPrefixedSequenceIdentifier("PrefixSequence"); fieldToc.setSequenceSeparator(">"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\c MySequence \\s PrefixSequence \\d >"); builder.insertBreak(BreakType.PAGE_BREAK); // Add two SEQ fields in one paragraph, setting the TOC's sequence and prefix sequence as their sequence identifiers FieldSeq fieldSeq = insertSeqField(builder, "PrefixSequence ", "", "PrefixSequence"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ PrefixSequence"); fieldSeq = insertSeqField(builder, ", MySequence ", "\n", "MySequence"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence"); insertSeqField(builder, "PrefixSequence ", "", "PrefixSequence"); insertSeqField(builder, ", MySequence ", "\n", "MySequence"); // If the sqeuence identifier doesn't match that of the TOC, the entry won't be included insertSeqField(builder, "PrefixSequence ", "", "PrefixSequence"); fieldSeq = insertSeqField(builder, ", MySequence ", "", "OtherSequence"); builder.writeln(" This text, from a different sequence, won't be included in the same TOC as the one above."); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ OtherSequence"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.Prefix.docx"); } public void tocSeqNumbering() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Filter by sequence identifier and a prefix sequence identifier, and change sequence separator FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); fieldToc.setTableOfFiguresLabel("MySequence"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\c MySequence"); builder.insertBreak(BreakType.PAGE_BREAK); // Set the current number of the sequence to 100 FieldSeq fieldSeq = insertSeqField(builder, "MySequence ", "\n", "MySequence"); fieldSeq.setResetNumber("100"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence \\r 100"); insertSeqField(builder, "MySequence ", "\n", "MySequence"); // Insert a heading builder.insertBreak(BreakType.PARAGRAPH_BREAK); builder.getParagraphFormat().setStyle(doc.getStyles().get("Heading 1")); builder.writeln("My heading"); builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal")); // Reset sequence when we encounter a heading, resetting the sequence back to 1 fieldSeq = insertSeqField(builder, "MySequence ", "\n", "MySequence"); fieldSeq.setResetHeadingLevel("1"); Assert.assertEquals(" SEQ MySequence \\s 1", fieldSeq.getFieldCode()); // Move to the next number fieldSeq = insertSeqField(builder, "MySequence ", "\n", "MySequence"); fieldSeq.setInsertNextNumber(true); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence \\n"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.ResetNumbering.docx"); } public void tocSeqBookmark() throws Exception { 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(fieldToc.getFieldCode(), " TOC \\c MySequence \\b TOCBookmark"); insertSeqField(builder, "MySequence ", "", "MySequence"); builder.writeln(" This text won't show up in the TOC because it is outside of the bookmark."); builder.startBookmark("TOCBookmark"); insertSeqField(builder, "MySequence ", "", "MySequence"); builder.writeln(" This text will show up in the TOC next to the entry for the above caption."); insertSeqField(builder, "OtherSequence ", "", "OtherSequence"); builder.writeln(" This text, from a different sequence, won't be included in the same TOC as the one above."); // 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 = insertSeqField(builder, " MySequence ", "\n", "MySequence"); fieldSeq.setBookmarkName("SEQBookmark"); Assert.assertEquals(fieldSeq.getFieldCode(), " SEQ MySequence SEQBookmark"); // Add bookmark to reference builder.insertBreak(BreakType.PAGE_BREAK); builder.startBookmark("SEQBookmark"); insertSeqField(builder, " MySequence ", "", "MySequence"); builder.writeln(" Text inside SEQBookmark."); builder.endBookmark("SEQBookmark"); builder.endBookmark("TOCBookmark"); doc.updateFields(); doc.save(getArtifactsDir() + "Field.TOC.SEQ.Bookmark.docx"); } /// <summary> /// Insert a sequence field with preceding text and a specified sequence identifier /// </summary> @Test(enabled = false) public FieldSeq insertSeqField(final DocumentBuilder builder, final String textBefore, final String textAfter, final String sequenceIdentifier) throws Exception { builder.write(textBefore); FieldSeq fieldSeq = (FieldSeq) builder.insertField(FieldType.FIELD_SEQUENCE, true); fieldSeq.setSequenceIdentifier(sequenceIdentifier); builder.write(textAfter); return fieldSeq; }
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();
getUseParagraphOutlineLevel/setUseParagraphOutlineLevel | |
public boolean getUseParagraphOutlineLevel() / public void setUseParagraphOutlineLevel(boolean value) |
Example:
Shows how to insert a TOC and populate it with entries based on heading styles.public void fieldToc() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // The table of contents we will insert will accept entries that are only within the scope of this bookmark builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); // Limit possible TOC entries to only those within the bookmark we name here fieldToc.setBookmarkName("MyBookmark"); // Normally paragraphs with a "Heading n" style will be the only ones that will be added to a TOC as entries // We can set this attribute to include other styles, such as "Quote" and "Intense Quote" in this case fieldToc.setCustomStyles("Quote; 6; Intense Quote; 7"); // Styles are normally separated by a comma (",") but we can use this property to set a custom delimiter doc.getFieldOptions().setCustomTocStyleSeparator(";"); // Filter out any headings that are outside this range fieldToc.setHeadingLevelRange("1-3"); // Headings in this range won't display their page number in their TOC entry fieldToc.setPageNumberOmittingLevelRange("2-5"); fieldToc.setEntrySeparator("-"); fieldToc.setInsertHyperlinks(true); fieldToc.setHideInWebLayout(false); fieldToc.setPreserveLineBreaks(true); fieldToc.setPreserveTabs(true); fieldToc.setUseParagraphOutlineLevel(false); insertHeading(builder, "First entry", "Heading 1"); builder.writeln("Paragraph text."); insertHeading(builder, "Second entry", "Heading 1"); insertHeading(builder, "Third entry", "Quote"); insertHeading(builder, "Fourth entry", "Intense Quote"); // These two headings will have the page numbers omitted because they are within the "2-5" range insertHeading(builder, "Fifth entry", "Heading 2"); insertHeading(builder, "Sixth entry", "Heading 3"); // This entry will be omitted because "Heading 4" is outside of the "1-3" range we set earlier insertHeading(builder, "Seventh entry", "Heading 4"); builder.endBookmark("MyBookmark"); builder.writeln("Paragraph text."); // This entry will be omitted because it is outside the bookmark specified by the TOC insertHeading(builder, "Eighth entry", "Heading 1"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w"); fieldToc.updatePageNumbers(); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.docx"); } /// <summary> /// Start a new page and insert a paragraph of a specified style /// </summary> @Test(enabled = false) public void insertHeading(final DocumentBuilder builder, final String captionText, final String styleName) { builder.insertBreak(BreakType.PAGE_BREAK); String originalStyle = builder.getParagraphFormat().getStyleName(); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(styleName)); builder.writeln(captionText); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(originalStyle)); }
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");
updatePageNumbers | |
public boolean updatePageNumbers() throws java.lang.Exception |
Example:
Shows how to insert a TOC and populate it with entries based on heading styles.public void fieldToc() throws Exception { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // The table of contents we will insert will accept entries that are only within the scope of this bookmark builder.startBookmark("MyBookmark"); // Insert a list num field using a document builder FieldToc fieldToc = (FieldToc) builder.insertField(FieldType.FIELD_TOC, true); // Limit possible TOC entries to only those within the bookmark we name here fieldToc.setBookmarkName("MyBookmark"); // Normally paragraphs with a "Heading n" style will be the only ones that will be added to a TOC as entries // We can set this attribute to include other styles, such as "Quote" and "Intense Quote" in this case fieldToc.setCustomStyles("Quote; 6; Intense Quote; 7"); // Styles are normally separated by a comma (",") but we can use this property to set a custom delimiter doc.getFieldOptions().setCustomTocStyleSeparator(";"); // Filter out any headings that are outside this range fieldToc.setHeadingLevelRange("1-3"); // Headings in this range won't display their page number in their TOC entry fieldToc.setPageNumberOmittingLevelRange("2-5"); fieldToc.setEntrySeparator("-"); fieldToc.setInsertHyperlinks(true); fieldToc.setHideInWebLayout(false); fieldToc.setPreserveLineBreaks(true); fieldToc.setPreserveTabs(true); fieldToc.setUseParagraphOutlineLevel(false); insertHeading(builder, "First entry", "Heading 1"); builder.writeln("Paragraph text."); insertHeading(builder, "Second entry", "Heading 1"); insertHeading(builder, "Third entry", "Quote"); insertHeading(builder, "Fourth entry", "Intense Quote"); // These two headings will have the page numbers omitted because they are within the "2-5" range insertHeading(builder, "Fifth entry", "Heading 2"); insertHeading(builder, "Sixth entry", "Heading 3"); // This entry will be omitted because "Heading 4" is outside of the "1-3" range we set earlier insertHeading(builder, "Seventh entry", "Heading 4"); builder.endBookmark("MyBookmark"); builder.writeln("Paragraph text."); // This entry will be omitted because it is outside the bookmark specified by the TOC insertHeading(builder, "Eighth entry", "Heading 1"); Assert.assertEquals(fieldToc.getFieldCode(), " TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w"); fieldToc.updatePageNumbers(); doc.updateFields(); doc.save(getArtifactsDir() + "Field.FieldTOC.docx"); } /// <summary> /// Start a new page and insert a paragraph of a specified style /// </summary> @Test(enabled = false) public void insertHeading(final DocumentBuilder builder, final String captionText, final String styleName) { builder.insertBreak(BreakType.PAGE_BREAK); String originalStyle = builder.getParagraphFormat().getStyleName(); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(styleName)); builder.writeln(captionText); builder.getParagraphFormat().setStyle(builder.getDocument().getStyles().get(originalStyle)); }