java.lang.ObjectNode
CompositeNode
com.aspose.words.Table
public class Table
Table is a block-level node and can be a child of classes derived from Story or
InlineStory. Table can contain one or more Row nodes. A minimal valid table needs to have at least one Row. Example: Example: Example:
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Table table = builder.startTable();
// Insert a cell
builder.insertCell();
// Use fixed column widths
table.autoFit(AutoFitBehavior.FIXED_COLUMN_WIDTHS);
builder.getCellFormat().setVerticalAlignment(CellVerticalAlignment.CENTER);
builder.write("This is row 1 cell 1");
// Insert a cell
builder.insertCell();
builder.write("This is row 1 cell 2");
builder.endRow();
// Insert a cell
builder.insertCell();
// Apply new row formatting
builder.getRowFormat().setHeight(100);
builder.getRowFormat().setHeightRule(HeightRule.EXACTLY);
builder.getCellFormat().setOrientation(TextOrientation.UPWARD);
builder.writeln("This is row 2 cell 1");
// Insert a cell
builder.insertCell();
builder.getCellFormat().setOrientation(TextOrientation.DOWNWARD);
builder.writeln("This is row 2 cell 2");
builder.endRow();
builder.endTable();
Document doc = new Document(getMyDir() + "Tables.docx");
// Here we get all tables from the Document node. You can do this for any other composite node
// which can contain block level nodes. For example you can retrieve tables from header or from a cell
// containing another table (nested tables)
TableCollection tables = doc.getFirstSection().getBody().getTables();
// We can make a new array to clone all of the tables in the collection
Assert.assertEquals(tables.toArray().length, 2);
// Iterate through all tables in the document
for (int i = 0; i < tables.getCount(); i++) {
// Get the index of the table node as contained in the parent node of the table
System.out.println(MessageFormat.format("Start of Table {0}", i));
RowCollection rows = tables.get(i).getRows();
// RowCollections can be cloned into arrays
Assert.assertNotSame(rows, rows.toArray());
// Iterate through all rows in the table
for (int j = 0; j < rows.getCount(); j++) {
System.out.println(MessageFormat.format("\tStart of Row {0}", j));
CellCollection cells = rows.get(j).getCells();
// RowCollections can also be cloned into arrays
Assert.assertNotSame(cells, cells.toArray());
// Iterate through all cells in the row
for (int k = 0; k < cells.getCount(); k++) {
// Get the plain text content of this cell.
String cellText = cells.get(k).toString(SaveFormat.TEXT).trim();
// Print the content of the cell.
System.out.println(MessageFormat.format("\t\tContents of Cell:{0} = \"{1}\"", k, cellText));
}
System.out.println(MessageFormat.format("\tEnd of Row {0}", j));
}
System.out.println(MessageFormat.format("End of Table {0}\n", i));
}
public void createNestedTable() throws Exception {
Document doc = new Document();
// Create the outer table with three rows and four columns
Table outerTable = createTable(doc, 3, 4, "Outer Table");
// Add it to the document body
doc.getFirstSection().getBody().appendChild(outerTable);
// Create another table with two rows and two columns
Table innerTable = createTable(doc, 2, 2, "Inner Table");
// Add this table to the first cell of the outer table
outerTable.getFirstRow().getFirstCell().appendChild(innerTable);
doc.save(getArtifactsDir() + "Table.CreateNestedTable.doc");
}
/**
* Creates a new table in the document with the given dimensions and text in each cell.
*/
private Table createTable(final Document doc, final int rowCount, final int cellCount, final String cellText) throws Exception {
Table table = new Table(doc);
// Create the specified number of rows
for (int rowId = 1; rowId <= rowCount; rowId++) {
Row row = new Row(doc);
table.appendChild(row);
// Create the specified number of cells for each row
for (int cellId = 1; cellId <= cellCount; cellId++) {
Cell cell = new Cell(doc);
row.appendChild(cell);
// Add a blank paragraph to the cell
cell.appendChild(new Paragraph(doc));
// Add the text
cell.getFirstParagraph().appendChild(new Run(doc, cellText));
}
}
// You can add title and description to your table only when added at least one row to the table first
// This properties are meaningful for ISO / IEC 29500 compliant DOCX documents(see the OoxmlCompliance class)
// When saved to pre-ISO/IEC 29500 formats, the properties are ignored
table.setTitle("Aspose table title");
table.setDescription("Aspose table description");
return table;
}
Constructor Summary |
---|
Table(DocumentBase doc)
Initializes a new instance of the Table class. |
Property Getters/Setters Summary | ||
---|---|---|
double | getAbsoluteHorizontalDistance() | |
void | setAbsoluteHorizontalDistance(double value) | |
Gets or sets absolute horizontal floating table position specified by the table properties, in points. Default value is 0. | ||
double | getAbsoluteVerticalDistance() | |
void | setAbsoluteVerticalDistance(double value) | |
Gets or sets absolute vertical floating table position specified by the table properties, in points. Default value is 0. | ||
int | getAlignment() | |
void | setAlignment(int value) | |
Specifies how an inline table is aligned in the document. The value of the property is TableAlignment integer constant. | ||
boolean | getAllowAutoFit() | |
void | setAllowAutoFit(boolean value) | |
Allows Microsoft Word and Aspose.Words to automatically resize cells in a table to fit their contents. | ||
boolean | getAllowCellSpacing() | |
void | setAllowCellSpacing(boolean value) | |
Gets or sets the "Allow spacing between cells" option. | ||
boolean | getAllowOverlap() | |
Gets whether a floating table shall allow other floating objects in the document
to overlap its extents when displayed.
Default value is true .
|
||
boolean | getBidi() | |
void | setBidi(boolean value) | |
Gets or sets whether this is a right-to-left table. | ||
double | getBottomPadding() | |
void | setBottomPadding(double value) | |
Gets or sets the amount of space (in points) to add below the contents of cells. | ||
double | getCellSpacing() | |
void | setCellSpacing(double value) | |
Gets or sets the amount of space (in points) between the cells. | ||
NodeCollection | getChildNodes() | → inherited from CompositeNode |
Gets all immediate child nodes of this node. | ||
int | getCount() | → inherited from CompositeNode |
Gets the number of immediate children of this node. | ||
java.lang.String | getDescription() | |
void | setDescription(java.lang.String value) | |
Gets or sets description of this table. It provides an alternative text representation of the information contained in the table. | ||
double | getDistanceBottom() | |
Gets distance between table bottom and the surrounding text, in points. | ||
double | getDistanceLeft() | |
Gets distance between table left and the surrounding text, in points. | ||
double | getDistanceRight() | |
Gets distance between table right and the surrounding text, in points. | ||
double | getDistanceTop() | |
Gets distance between table top and the surrounding text, in points. | ||
DocumentBase | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
Node | getFirstChild() | → inherited from CompositeNode |
Gets the first child of the node. | ||
Row | getFirstRow() | |
Returns the first Row node in the table. | ||
boolean | hasChildNodes() | → inherited from CompositeNode |
Returns true if this node has any child nodes. | ||
int | getHorizontalAnchor() | |
void | setHorizontalAnchor(int value) | |
Gets the base object from which the horizontal positioning of floating table should be calculated.
Default value is |
||
boolean | isComposite() | → inherited from CompositeNode |
Returns true as this node can have child nodes. | ||
Node | getLastChild() | → inherited from CompositeNode |
Gets the last child of the node. | ||
Row | getLastRow() | |
Returns the last Row node in the table. | ||
double | getLeftIndent() | |
void | setLeftIndent(double value) | |
Gets or sets the value that represents the left indent of the table. | ||
double | getLeftPadding() | |
void | setLeftPadding(double value) | |
Gets or sets the amount of space (in points) to add to the left of the contents of cells. | ||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
int | getNodeType() | |
Returns NodeType.Table. The value of the property is NodeType integer constant. | ||
CompositeNode | getParentNode() | → inherited from Node |
Gets the immediate parent of this node. | ||
PreferredWidth | getPreferredWidth() | |
void | setPreferredWidth(PreferredWidth value) | |
Gets or sets the table preferred width. | ||
Node | getPreviousSibling() | → inherited from Node |
Gets the node immediately preceding this node. | ||
Range | getRange() | → inherited from Node |
Returns a Range object that represents the portion of a document that is contained in this node. | ||
int | getRelativeHorizontalAlignment() | |
void | setRelativeHorizontalAlignment(int value) | |
Gets or sets floating table relative horizontal alignment. The value of the property is HorizontalAlignment integer constant. | ||
int | getRelativeVerticalAlignment() | |
void | setRelativeVerticalAlignment(int value) | |
Gets or sets floating table relative vertical alignment. The value of the property is VerticalAlignment integer constant. | ||
double | getRightPadding() | |
void | setRightPadding(double value) | |
Gets or sets the amount of space (in points) to add to the right of the contents of cells. | ||
RowCollection | getRows() | |
Provides typed access to the rows of the table. | ||
Style | getStyle() | |
void | setStyle(Style value) | |
Gets or sets the table style applied to this table. | ||
int | getStyleIdentifier() | |
void | setStyleIdentifier(int value) | |
Gets or sets the locale independent style identifier of the table style applied to this table. The value of the property is StyleIdentifier integer constant. | ||
java.lang.String | getStyleName() | |
void | setStyleName(java.lang.String value) | |
Gets or sets the name of the table style applied to this table. | ||
int | getStyleOptions() | |
void | setStyleOptions(int value) | |
Gets or sets bit flags that specify how a table style is applied to this table. The value of the property is TableStyleOptions integer constant. | ||
int | getTextWrapping() | |
void | setTextWrapping(int value) | |
Gets or sets |
||
java.lang.String | getTitle() | |
void | setTitle(java.lang.String value) | |
Gets or sets title of this table. It provides an alternative text representation of the information contained in the table. | ||
double | getTopPadding() | |
void | setTopPadding(double value) | |
Gets or sets the amount of space (in points) to add above the contents of cells. | ||
int | getVerticalAnchor() | |
void | setVerticalAnchor(int value) | |
Gets the base object from which the vertical positioning of floating table should be calculated.
Default value is |
Method Summary | ||
---|---|---|
boolean | accept(DocumentVisitor visitor) | |
Accepts a visitor. | ||
Node | appendChild(Node newChild) | → inherited from CompositeNode |
Adds the specified node to the end of the list of child nodes for this node. | ||
void | autoFit(int behavior) | |
Resizes the table and cells according to the specified auto fit behavior. | ||
void | clearBorders() | |
Removes all table and cell borders on this table. | ||
void | clearShading() | |
Removes all shading on the table. | ||
void | convertToHorizontallyMergedCells() | |
Converts cells horizontally merged by width to cells merged by |
||
Node | deepClone(boolean isCloneChildren) | → inherited from Node |
void | ensureMinimum() | |
If the table has no rows, creates and appends one Row. | ||
CompositeNode | getAncestor(int ancestorType) | → inherited from Node |
Gets the first ancestor of the specified |
||
CompositeNode | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified object type. | ||
Node | getChild(int nodeType, int index, boolean isDeep) | → inherited from CompositeNode |
Returns an Nth child node that matches the specified type. | ||
NodeCollection | getChildNodes(int nodeType, boolean isDeep) | → inherited from CompositeNode |
Returns a live collection of child nodes that match the specified type. | ||
java.lang.String | getText() | → inherited from CompositeNode |
Gets the text of this node and of all its children. | ||
int | indexOf(Node child) | → inherited from CompositeNode |
Returns the index of the specified child node in the child node array. | ||
Node | insertAfter(Node newChild, Node refChild) | → inherited from CompositeNode |
Inserts the specified node immediately after the specified reference node. | ||
Node | insertBefore(Node newChild, Node refChild) | → inherited from CompositeNode |
Inserts the specified node immediately before the specified reference node. | ||
java.util.Iterator<Node> | iterator() | → inherited from CompositeNode |
Provides support for the for each style iteration over the child nodes of this node. | ||
Node | nextPreOrder(Node rootNode) | → inherited from Node |
Gets next node according to the pre-order tree traversal algorithm. | ||
Node | prependChild(Node newChild) | → inherited from CompositeNode |
Adds the specified node to the beginning of the list of child nodes for this node. | ||
Node | previousPreOrder(Node rootNode) | → inherited from Node |
Gets the previous node according to the pre-order tree traversal algorithm. | ||
void | remove() | → inherited from Node |
Removes itself from the parent. | ||
void | removeAllChildren() | → inherited from CompositeNode |
Removes all the child nodes of the current node. | ||
Node | removeChild(Node oldChild) | → inherited from CompositeNode |
Removes the specified child node. | ||
void | removeSmartTags() | → inherited from CompositeNode |
Removes all |
||
NodeList | selectNodes(java.lang.String xpath) | → inherited from CompositeNode |
Selects a list of nodes matching the XPath expression. | ||
Node | selectSingleNode(java.lang.String xpath) | → inherited from CompositeNode |
Selects the first Node that matches the XPath expression. | ||
void | setBorder(int borderType, int lineStyle, double lineWidth, java.awt.Color color, boolean isOverrideCellBorders) | |
Sets the specified table border to the specified line style, width and color. | ||
void | setBorders(int lineStyle, double lineWidth, java.awt.Color color) | |
Sets all table borders to the specified line style, width and color. | ||
void | setShading(int texture, java.awt.Color foregroundColor, java.awt.Color backgroundColor) | |
Sets shading to the specified values on all cells in the table. | ||
java.lang.String | toString(SaveOptions saveOptions) | → inherited from Node |
Exports the content of the node into a string using the specified save options. | ||
java.lang.String | toString(int saveFormat) | → inherited from Node |
Exports the content of the node into a string in the specified format. |
Constructor Detail |
---|
public Table(DocumentBase doc)
When Table is created, it belongs to the specified document, but is not yet part of the document and ParentNode is null.
To append Table to the document use InsertAfter or InsertBefore on the story where you want the table inserted.
doc
- The owner document.Example:
Shows how to build a nested table without using DocumentBuilder.public void createNestedTable() throws Exception { Document doc = new Document(); // Create the outer table with three rows and four columns Table outerTable = createTable(doc, 3, 4, "Outer Table"); // Add it to the document body doc.getFirstSection().getBody().appendChild(outerTable); // Create another table with two rows and two columns Table innerTable = createTable(doc, 2, 2, "Inner Table"); // Add this table to the first cell of the outer table outerTable.getFirstRow().getFirstCell().appendChild(innerTable); doc.save(getArtifactsDir() + "Table.CreateNestedTable.doc"); } /** * Creates a new table in the document with the given dimensions and text in each cell. */ private Table createTable(final Document doc, final int rowCount, final int cellCount, final String cellText) throws Exception { Table table = new Table(doc); // Create the specified number of rows for (int rowId = 1; rowId <= rowCount; rowId++) { Row row = new Row(doc); table.appendChild(row); // Create the specified number of cells for each row for (int cellId = 1; cellId <= cellCount; cellId++) { Cell cell = new Cell(doc); row.appendChild(cell); // Add a blank paragraph to the cell cell.appendChild(new Paragraph(doc)); // Add the text cell.getFirstParagraph().appendChild(new Run(doc, cellText)); } } // You can add title and description to your table only when added at least one row to the table first // This properties are meaningful for ISO / IEC 29500 compliant DOCX documents(see the OoxmlCompliance class) // When saved to pre-ISO/IEC 29500 formats, the properties are ignored table.setTitle("Aspose table title"); table.setDescription("Aspose table description"); return table; }
Property Getters/Setters Detail |
---|
getAbsoluteHorizontalDistance/setAbsoluteHorizontalDistance | |
public double getAbsoluteHorizontalDistance() / public void setAbsoluteHorizontalDistance(double value) |
Example:
Shows how get/set properties for floating tables.Document doc = new Document(getMyDir() + "Table wrapped by text.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); table.setAbsoluteHorizontalDistance(10.0); table.setAbsoluteVerticalDistance(15.0); // Check that absolute distance was set correct Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 10.0); Assert.assertEquals(table.getAbsoluteVerticalDistance(), 15.0); // Setting RelativeHorizontalAlignment will reset AbsoluteHorizontalDistance to default value and vice versa, // the same is for vertical positioning table.setRelativeVerticalAlignment(VerticalAlignment.TOP); table.setRelativeHorizontalAlignment(HorizontalAlignment.CENTER); // Check that AbsoluteHorizontalDistance and AbsoluteVerticalDistance are reset Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0); Assert.assertEquals(table.getAbsoluteVerticalDistance(), 0.0); Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.TOP); Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.CENTER); doc.save(getArtifactsDir() + "Table.ChangeFloatingTableProperties.docx");
getAbsoluteVerticalDistance/setAbsoluteVerticalDistance | |
public double getAbsoluteVerticalDistance() / public void setAbsoluteVerticalDistance(double value) |
Example:
Shows how get/set properties for floating tables.Document doc = new Document(getMyDir() + "Table wrapped by text.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); table.setAbsoluteHorizontalDistance(10.0); table.setAbsoluteVerticalDistance(15.0); // Check that absolute distance was set correct Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 10.0); Assert.assertEquals(table.getAbsoluteVerticalDistance(), 15.0); // Setting RelativeHorizontalAlignment will reset AbsoluteHorizontalDistance to default value and vice versa, // the same is for vertical positioning table.setRelativeVerticalAlignment(VerticalAlignment.TOP); table.setRelativeHorizontalAlignment(HorizontalAlignment.CENTER); // Check that AbsoluteHorizontalDistance and AbsoluteVerticalDistance are reset Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0); Assert.assertEquals(table.getAbsoluteVerticalDistance(), 0.0); Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.TOP); Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.CENTER); doc.save(getArtifactsDir() + "Table.ChangeFloatingTableProperties.docx");
getAlignment/setAlignment | |
public int getAlignment() / public void setAlignment(int value) |
The default value is
Example:
Shows how to apply a outline border to a table.Document doc = new Document(getMyDir() + "Tables.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); // Align the table to the center of the page table.setAlignment(TableAlignment.CENTER); // Clear any existing borders and shading from the table table.clearBorders(); table.clearShading(); // Set a green border around the table but not inside table.setBorder(BorderType.LEFT, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.RIGHT, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.TOP, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.BOTTOM, LineStyle.SINGLE, 1.5, Color.GREEN, true); // Fill the cells with a light green solid color table.setShading(TextureIndex.TEXTURE_SOLID, Color.GREEN, Color.GREEN); doc.save(getArtifactsDir() + "Table.SetOutlineBorders.docx");
getAllowAutoFit/setAllowAutoFit | |
public boolean getAllowAutoFit() / public void setAllowAutoFit(boolean value) |
The default value is true
.
Example:
Shows how to set a table to shrink or grow each cell to accommodate its contents.table.setAllowAutoFit(true);
getAllowCellSpacing/setAllowCellSpacing | |
public boolean getAllowCellSpacing() / public void setAllowCellSpacing(boolean value) |
Example:
Shows how to insert a table using the constructors of nodes.Document doc = new Document(); // We start by creating the table object. Note how we must pass the document object // to the constructor of each node. This is because every node we create must belong // to some document Table table = new Table(doc); // Add the table to the document doc.getFirstSection().getBody().appendChild(table); // Here we could call EnsureMinimum to create the rows and cells for us. This method is used // to ensure that the specified node is valid, in this case a valid table should have at least one // row and one cell, therefore this method creates them for us // Instead we will handle creating the row and table ourselves. This would be the best way to do this // if we were creating a table inside an algorithm for example Row row = new Row(doc); row.getRowFormat().setAllowBreakAcrossPages(true); table.appendChild(row); // We can now apply any auto fit settings table.autoFit(AutoFitBehavior.FIXED_COLUMN_WIDTHS); // Create a cell and add it to the row Cell cell = new Cell(doc); cell.getCellFormat().getShading().setBackgroundPatternColor(Color.BLUE); cell.getCellFormat().setWidth(80); // Add a paragraph to the cell as well as a new run with some text cell.appendChild(new Paragraph(doc)); cell.getFirstParagraph().appendChild(new Run(doc, "Row 1, Cell 1 Text")); // Add the cell to the row row.appendChild(cell); // We would then repeat the process for the other cells and rows in the table // We can also speed things up by cloning existing cells and rows row.appendChild(cell.deepClone(false)); row.getLastCell().appendChild(new Paragraph(doc)); row.getLastCell().getFirstParagraph().appendChild(new Run(doc, "Row 1, Cell 2 Text")); // Remove spacing between cells table.setAllowCellSpacing(false); doc.save(getArtifactsDir() + "Table.InsertTableUsingNodes.doc");
getAllowOverlap | |
public boolean getAllowOverlap() |
true
.
Example:
Shows how get properties for floating tables.Document doc = new Document(getMyDir() + "Table wrapped by text.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); if (table.getTextWrapping() == TextWrapping.AROUND) { Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.CENTER); Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.DEFAULT); Assert.assertEquals(table.getHorizontalAnchor(), RelativeHorizontalPosition.MARGIN); Assert.assertEquals(table.getVerticalAnchor(), RelativeVerticalPosition.PARAGRAPH); Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0); Assert.assertEquals(table.getAbsoluteVerticalDistance(), 56.15); Assert.assertEquals(table.getAllowOverlap(), false); }
getBidi/setBidi | |
public boolean getBidi() / public void setBidi(boolean value) |
When true
, the cells in this row are laid out right to left.
The default value is false
.
Example:
Shows how to create your own style settings for the table.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); builder.insertCell(); builder.write("Name"); builder.insertCell(); builder.write("??????"); builder.endRow(); builder.insertCell(); builder.insertCell(); builder.endTable(); TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1"); tableStyle.setAllowBreakAcrossPages(true); tableStyle.setBidi(true); tableStyle.setCellSpacing(5.0); tableStyle.setBottomPadding(20.0); tableStyle.setLeftPadding(5.0); tableStyle.setRightPadding(10.0); tableStyle.setTopPadding(20.0); tableStyle.getShading().setBackgroundPatternColor(Color.WHITE); tableStyle.getBorders().setColor(Color.BLACK); tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH); table.setStyle(tableStyle); // Some Table attributes are linked to style variables Assert.assertEquals(table.getBidi(), true); Assert.assertEquals(table.getCellSpacing(), 5.0); Assert.assertEquals(table.getStyleName(), "MyTableStyle1"); doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");
getBottomPadding/setBottomPadding | |
public double getBottomPadding() / public void setBottomPadding(double value) |
Example:
Shows how to create a table that contains a single cell and apply row formatting.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); builder.insertCell(); // Set the row formatting RowFormat rowFormat = builder.getRowFormat(); rowFormat.setHeight(100); rowFormat.setHeightRule(HeightRule.EXACTLY); // These formatting properties are set on the table and are applied to all rows in the table table.setLeftPadding(30); table.setRightPadding(30); table.setTopPadding(30); table.setBottomPadding(30); builder.writeln("Contents of formatted row."); builder.endRow(); builder.endTable();
getCellSpacing/setCellSpacing | |
public double getCellSpacing() / public void setCellSpacing(double value) |
Example:
Shows how to create your own style settings for the table.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); builder.insertCell(); builder.write("Name"); builder.insertCell(); builder.write("??????"); builder.endRow(); builder.insertCell(); builder.insertCell(); builder.endTable(); TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1"); tableStyle.setAllowBreakAcrossPages(true); tableStyle.setBidi(true); tableStyle.setCellSpacing(5.0); tableStyle.setBottomPadding(20.0); tableStyle.setLeftPadding(5.0); tableStyle.setRightPadding(10.0); tableStyle.setTopPadding(20.0); tableStyle.getShading().setBackgroundPatternColor(Color.WHITE); tableStyle.getBorders().setColor(Color.BLACK); tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH); table.setStyle(tableStyle); // Some Table attributes are linked to style variables Assert.assertEquals(table.getBidi(), true); Assert.assertEquals(table.getCellSpacing(), 5.0); Assert.assertEquals(table.getStyleName(), "MyTableStyle1"); doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");
getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes() |
Note, GetChildNodes(NodeType.Any, false)
and creates and returns a new collection every time it is accessed.
If there are no child nodes, this property returns an empty collection.
Example:
Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.NodeCollection children = paragraph.getChildNodes(); for (Node child : (Iterable<Node>) children) { // Paragraph may contain children of various types such as runs, shapes and so on if (child.getNodeType() == NodeType.RUN) { // Say we found the node that we want, do something useful Run run = (Run) child; System.out.println(run.getText()); } }
getCount | → inherited from CompositeNode |
public int getCount() |
Example:
Shows how to add, update and delete child nodes from within a CompositeNode.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1); // A paragraph is a composite node because it can contain runs, which are another type of node Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph(); Run paragraphText = new Run(doc, "Initial text. "); paragraph.appendChild(paragraphText); // We will place these 3 children into the main text of our paragraph Run run1 = new Run(doc, "Run 1. "); Run run2 = new Run(doc, "Run 2. "); Run run3 = new Run(doc, "Run 3. "); // We initialized them but not in our paragraph yet Assert.assertEquals(paragraph.getText(), "Initial text. " + (char) 12); // Insert run2 before initial paragraph text. This will be at the start of the paragraph paragraph.insertBefore(run2, paragraphText); // Insert run3 after initial paragraph text. This will be at the end of the paragraph paragraph.insertAfter(run3, paragraphText); // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1 paragraph.prependChild(run1); Assert.assertEquals(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4); // Access the child node collection and update/delete children ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. "); paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText); Assert.assertEquals(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);
getDescription/setDescription | |
public java.lang.String getDescription() / public void setDescription(java.lang.String value) |
The default value is an empty string.
This property is meaningful for ISO/IEC 29500 compliant DOCX documents
(
Example:
Shows how to build a nested table without using DocumentBuilder.public void createNestedTable() throws Exception { Document doc = new Document(); // Create the outer table with three rows and four columns Table outerTable = createTable(doc, 3, 4, "Outer Table"); // Add it to the document body doc.getFirstSection().getBody().appendChild(outerTable); // Create another table with two rows and two columns Table innerTable = createTable(doc, 2, 2, "Inner Table"); // Add this table to the first cell of the outer table outerTable.getFirstRow().getFirstCell().appendChild(innerTable); doc.save(getArtifactsDir() + "Table.CreateNestedTable.doc"); } /** * Creates a new table in the document with the given dimensions and text in each cell. */ private Table createTable(final Document doc, final int rowCount, final int cellCount, final String cellText) throws Exception { Table table = new Table(doc); // Create the specified number of rows for (int rowId = 1; rowId <= rowCount; rowId++) { Row row = new Row(doc); table.appendChild(row); // Create the specified number of cells for each row for (int cellId = 1; cellId <= cellCount; cellId++) { Cell cell = new Cell(doc); row.appendChild(cell); // Add a blank paragraph to the cell cell.appendChild(new Paragraph(doc)); // Add the text cell.getFirstParagraph().appendChild(new Run(doc, cellText)); } } // You can add title and description to your table only when added at least one row to the table first // This properties are meaningful for ISO / IEC 29500 compliant DOCX documents(see the OoxmlCompliance class) // When saved to pre-ISO/IEC 29500 formats, the properties are ignored table.setTitle("Aspose table title"); table.setDescription("Aspose table description"); return table; }
getDistanceBottom | |
public double getDistanceBottom() |
Example:
Shows the minimum distance operations between table boundaries and text.Document doc = new Document(getMyDir() + "Table wrapped by text.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); Assert.assertEquals(table.getDistanceTop(), 25.9d); Assert.assertEquals(table.getDistanceBottom(), 25.9d); Assert.assertEquals(table.getDistanceLeft(), 17.3d); Assert.assertEquals(table.getDistanceRight(), 17.3d);
getDistanceLeft | |
public double getDistanceLeft() |
Example:
Shows the minimum distance operations between table boundaries and text.Document doc = new Document(getMyDir() + "Table wrapped by text.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); Assert.assertEquals(table.getDistanceTop(), 25.9d); Assert.assertEquals(table.getDistanceBottom(), 25.9d); Assert.assertEquals(table.getDistanceLeft(), 17.3d); Assert.assertEquals(table.getDistanceRight(), 17.3d);
getDistanceRight | |
public double getDistanceRight() |
Example:
Shows the minimum distance operations between table boundaries and text.Document doc = new Document(getMyDir() + "Table wrapped by text.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); Assert.assertEquals(table.getDistanceTop(), 25.9d); Assert.assertEquals(table.getDistanceBottom(), 25.9d); Assert.assertEquals(table.getDistanceLeft(), 17.3d); Assert.assertEquals(table.getDistanceRight(), 17.3d);
getDistanceTop | |
public double getDistanceTop() |
Example:
Shows the minimum distance operations between table boundaries and text.Document doc = new Document(getMyDir() + "Table wrapped by text.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); Assert.assertEquals(table.getDistanceTop(), 25.9d); Assert.assertEquals(table.getDistanceBottom(), 25.9d); Assert.assertEquals(table.getDistanceLeft(), 17.3d); Assert.assertEquals(table.getDistanceRight(), 17.3d);
getDocument | → inherited from Node |
public DocumentBase getDocument() |
The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.
Example:
Shows that when you create any node, it requires a document that will own the node.// Open a file from disk Document doc = new Document(); // Creating a new node of any type requires a document passed into the constructor Paragraph para = new Paragraph(doc); // The new paragraph node does not yet have a parent System.out.println("Paragraph has no parent node: " + (para.getParentNode() == null)); // But the paragraph node knows its document System.out.println("Both nodes' documents are the same: " + (para.getDocument() == doc)); // The fact that a node always belongs to a document allows us to access and modify // properties that reference the document-wide data such as styles or lists para.getParagraphFormat().setStyleName("Heading 1"); // Now add the paragraph to the main text of the first section doc.getFirstSection().getBody().appendChild(para); // The paragraph node is now a child of the Body node System.out.println("Paragraph has a parent node: " + (para.getParentNode() != null));
getFirstChild | → inherited from CompositeNode |
public Node getFirstChild() |
Example:
Shows how to enumerate immediate child nodes of a composite node using NextSibling.// In this example we enumerate all paragraphs of a section body // Get the section that we want to work on Section section = doc.getSections().get(0); Body body = section.getBody(); // Loop starting from the first child until we reach null for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling()) { // Output the types of the nodes that we come across System.out.println(Node.nodeTypeToString(node.getNodeType())); }
Example:
Shows how to efficiently visit all direct and indirect children of a composite node.public void recurseAllNodes() throws Exception { // Open a document Document doc = new Document(getMyDir() + "Document.docx"); // Invoke the recursive function that will walk the tree traverseAllNodes(doc); } /** * A simple function that will walk through all children of a specified node recursively * and print the type of each node to the screen. */ @Test(enabled = false) public void traverseAllNodes(final CompositeNode parentNode) { // This is the most efficient way to loop through immediate children of a node for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) { // Do some useful work System.out.println(Node.nodeTypeToString(childNode.getNodeType())); // Recurse into the node if it is a composite node if (childNode.isComposite()) { traverseAllNodes((CompositeNode) childNode); } } }
getFirstRow | |
public Row getFirstRow() |
Example:
Shows how to use typed properties to access nodes of the document tree.// Quick typed access to the first child Section node of the Document Section section = doc.getFirstSection(); // Quick typed access to the Body child node of the Section Body body = section.getBody(); // Quick typed access to all Table child nodes contained in the Body TableCollection tables = body.getTables(); for (Table table : tables) { // Quick typed access to the first row of the table if (table.getFirstRow() != null) { table.getFirstRow().remove(); } // Quick typed access to the last row of the table if (table.getLastRow() != null) { table.getLastRow().remove(); } }
Example:
Shows how to combine the rows from two tables into one.// Load the document Document doc = new Document(getMyDir() + "Tables.docx"); // Get the first and second table in the document // The rows from the second table will be appended to the end of the first table Table firstTable = (Table) doc.getChild(NodeType.TABLE, 0, true); Table secondTable = (Table) doc.getChild(NodeType.TABLE, 1, true); // Append all rows from the current table to the next // Due to the design of tables even tables with different cell count and widths can be joined into one table while (secondTable.hasChildNodes()) firstTable.getRows().add(secondTable.getFirstRow()); // Remove the empty table container secondTable.remove(); doc.save(getArtifactsDir() + "Table.CombineTables.doc");
hasChildNodes | → inherited from CompositeNode |
public boolean hasChildNodes() |
getHorizontalAnchor/setHorizontalAnchor | |
public int getHorizontalAnchor() / public void setHorizontalAnchor(int value) |
Example:
Shows how get properties for floating tables.Document doc = new Document(getMyDir() + "Table wrapped by text.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); if (table.getTextWrapping() == TextWrapping.AROUND) { Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.CENTER); Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.DEFAULT); Assert.assertEquals(table.getHorizontalAnchor(), RelativeHorizontalPosition.MARGIN); Assert.assertEquals(table.getVerticalAnchor(), RelativeVerticalPosition.PARAGRAPH); Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0); Assert.assertEquals(table.getAbsoluteVerticalDistance(), 56.15); Assert.assertEquals(table.getAllowOverlap(), false); }
isComposite | → inherited from CompositeNode |
public boolean isComposite() |
Example:
Shows how to efficiently visit all direct and indirect children of a composite node.public void recurseAllNodes() throws Exception { // Open a document Document doc = new Document(getMyDir() + "Document.docx"); // Invoke the recursive function that will walk the tree traverseAllNodes(doc); } /** * A simple function that will walk through all children of a specified node recursively * and print the type of each node to the screen. */ @Test(enabled = false) public void traverseAllNodes(final CompositeNode parentNode) { // This is the most efficient way to loop through immediate children of a node for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) { // Do some useful work System.out.println(Node.nodeTypeToString(childNode.getNodeType())); // Recurse into the node if it is a composite node if (childNode.isComposite()) { traverseAllNodes((CompositeNode) childNode); } } }
getLastChild | → inherited from CompositeNode |
public Node getLastChild() |
Example:
Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.// Document is a CompositeNode and LastChild returns the last child node in the Document node // Since the Document can contain only Section nodes, the last child is the last section Node lastSection = doc.getLastChild(); // Each node knows its next and previous sibling nodes // Previous sibling of a section is a section before the specified section // If the node is the first child, PreviousSibling will return null Node sectionBeforeLast = lastSection.getPreviousSibling(); if (sectionBeforeLast != null) { doc.removeChild(sectionBeforeLast); }
getLastRow | |
public Row getLastRow() |
Example:
Shows how to use typed properties to access nodes of the document tree.// Quick typed access to the first child Section node of the Document Section section = doc.getFirstSection(); // Quick typed access to the Body child node of the Section Body body = section.getBody(); // Quick typed access to all Table child nodes contained in the Body TableCollection tables = body.getTables(); for (Table table : tables) { // Quick typed access to the first row of the table if (table.getFirstRow() != null) { table.getFirstRow().remove(); } // Quick typed access to the last row of the table if (table.getLastRow() != null) { table.getLastRow().remove(); } }
getLeftIndent/setLeftIndent | |
public double getLeftIndent() / public void setLeftIndent(double value) |
Example:
Shows how to create a formatted table using DocumentBuilder.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); // Make the header row builder.insertCell(); // Set the left indent for the table. Table wide formatting must be applied after // at least one row is present in the table table.setLeftIndent(20.0); // Set height and define the height rule for the header row builder.getRowFormat().setHeight(40.0); builder.getRowFormat().setHeightRule(HeightRule.AT_LEAST); // Some special features for the header row builder.getCellFormat().getShading().setBackgroundPatternColor(new Color(198, 217, 241)); builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER); builder.getFont().setSize(16); builder.getFont().setName("Arial"); builder.getFont().setBold(true); builder.getCellFormat().setWidth(100.0); builder.write("Header Row,\n Cell 1"); // We don't need to specify the width of this cell because it's inherited from the previous cell builder.insertCell(); builder.write("Header Row,\n Cell 2"); builder.insertCell(); builder.getCellFormat().setWidth(200.0); builder.write("Header Row,\n Cell 3"); builder.endRow(); // Set features for the other rows and cells builder.getCellFormat().getShading().setBackgroundPatternColor(Color.WHITE); builder.getCellFormat().setWidth(100.0); builder.getCellFormat().setVerticalAlignment(CellVerticalAlignment.CENTER); // Reset height and define a different height rule for table body builder.getRowFormat().setHeight(30.0); builder.getRowFormat().setHeightRule(HeightRule.AUTO); builder.insertCell(); // Reset font formatting builder.getFont().setSize(12); builder.getFont().setBold(false); // Build the other cells builder.write("Row 1, Cell 1 Content"); builder.insertCell(); builder.write("Row 1, Cell 2 Content"); builder.insertCell(); builder.getCellFormat().setWidth(200.0); builder.write("Row 1, Cell 3 Content"); builder.endRow(); builder.insertCell(); builder.getCellFormat().setWidth(100.0); builder.write("Row 2, Cell 1 Content"); builder.insertCell(); builder.write("Row 2, Cell 2 Content"); builder.insertCell(); builder.getCellFormat().setWidth(200.0); builder.write("Row 2, Cell 3 Content."); builder.endRow(); builder.endTable(); doc.save(getArtifactsDir() + "DocumentBuilder.CreateFormattedTable.doc");
getLeftPadding/setLeftPadding | |
public double getLeftPadding() / public void setLeftPadding(double value) |
Example:
Shows how to create a table that contains a single cell and apply row formatting.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); builder.insertCell(); // Set the row formatting RowFormat rowFormat = builder.getRowFormat(); rowFormat.setHeight(100); rowFormat.setHeightRule(HeightRule.EXACTLY); // These formatting properties are set on the table and are applied to all rows in the table table.setLeftPadding(30); table.setRightPadding(30); table.setTopPadding(30); table.setBottomPadding(30); builder.writeln("Contents of formatted row."); builder.endRow(); builder.endTable();
getNextSibling | → inherited from Node |
public Node getNextSibling() |
Example:
Shows how to enumerate immediate child nodes of a composite node using NextSibling.// In this example we enumerate all paragraphs of a section body // Get the section that we want to work on Section section = doc.getSections().get(0); Body body = section.getBody(); // Loop starting from the first child until we reach null for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling()) { // Output the types of the nodes that we come across System.out.println(Node.nodeTypeToString(node.getNodeType())); }
Example:
Shows how to efficiently visit all direct and indirect children of a composite node.public void recurseAllNodes() throws Exception { // Open a document Document doc = new Document(getMyDir() + "Document.docx"); // Invoke the recursive function that will walk the tree traverseAllNodes(doc); } /** * A simple function that will walk through all children of a specified node recursively * and print the type of each node to the screen. */ @Test(enabled = false) public void traverseAllNodes(final CompositeNode parentNode) { // This is the most efficient way to loop through immediate children of a node for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) { // Do some useful work System.out.println(Node.nodeTypeToString(childNode.getNodeType())); // Recurse into the node if it is a composite node if (childNode.isComposite()) { traverseAllNodes((CompositeNode) childNode); } } }
getNodeType | |
public int getNodeType() |
Example:
Shows how to retrieve the NodeType enumeration of nodes.Document doc = new Document(getMyDir() + "Document.docx"); // Let's pick a node that we can't be quite sure of what type it is // In this case lets pick the first node of the first paragraph in the body of the document Node node = doc.getFirstSection().getBody().getFirstParagraph().getFirstChild(); System.out.println("NodeType of first child: " + Node.nodeTypeToString(node.getNodeType())); // This time let's pick a node that we know the type of // Create a new paragraph and a table node Paragraph para = new Paragraph(doc); Table table = new Table(doc); // Access to NodeType for typed nodes will always return their specific NodeType // i.e A paragraph node will always return NodeType.Paragraph, a table node will always return NodeType.Table System.out.println("NodeType of Paragraph: " + Node.nodeTypeToString(para.getNodeType())); System.out.println("NodeType of Table: " + Node.nodeTypeToString(table.getNodeType()));
Example:
Shows how to find out if a table contains another table or if the table itself is nested inside another table.public void calculateDepthOfNestedTables() throws Exception { Document doc = new Document(getMyDir() + "Nested tables.docx"); int tableIndex = 0; for (Table table : (Iterable<Table>) doc.getChildNodes(NodeType.TABLE, true)) { // First lets find if any cells in the table have tables themselves as children int count = getChildTableCount(table); System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", tableIndex, count)); // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth int tableDepth = getNestedDepthOfTable(table); if (tableDepth > 0) { System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", tableIndex, tableDepth)); } else { System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", tableIndex)); } tableIndex++; } } /** * Calculates what level a table is nested inside other tables. * * @returns An integer containing the level the table is nested at. * 0 = Table is not nested inside any other table * 1 = Table is nested within one parent table * 2 = Table is nested within two parent tables etc.. */ private static int getNestedDepthOfTable(final Table table) { int depth = 0; int type = table.getNodeType(); // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table Node parent = table.getAncestor(table.getNodeType()); while (parent != null) { // Every time we find a table a level up we increase the depth counter and then try to find an // ancestor of type table from the parent depth++; parent = parent.getAncestor(Table.class); } return depth; } /** * Determines if a table contains any immediate child table within its cells. * Does not recursively traverse through those tables to check for further tables. * * @returns Returns true if at least one child cell contains a table. * Returns false if no cells in the table contains a table. */ private static int getChildTableCount(final Table table) { int tableCount = 0; // Iterate through all child rows in the table for (Row row : table.getRows()) { // Iterate through all child cells in the row for (Cell cell : row.getCells()) { // Retrieve the collection of child tables of this cell TableCollection childTables = cell.getTables(); // If this cell has a table as a child then return true if (childTables.getCount() > 0) tableCount++; } } // No cell contains a table return tableCount; }
getParentNode | → inherited from Node |
public CompositeNode getParentNode() |
If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.
Example:
Shows how to access the parent node.// Create a new empty document. It has one section Document doc = new Document(); // The section is the first child node of the document Node section = doc.getFirstChild(); // The section's parent node is the document System.out.println("Section parent is the document: " + (doc == section.getParentNode()));
Example:
Shows that when you create any node, it requires a document that will own the node.// Open a file from disk Document doc = new Document(); // Creating a new node of any type requires a document passed into the constructor Paragraph para = new Paragraph(doc); // The new paragraph node does not yet have a parent System.out.println("Paragraph has no parent node: " + (para.getParentNode() == null)); // But the paragraph node knows its document System.out.println("Both nodes' documents are the same: " + (para.getDocument() == doc)); // The fact that a node always belongs to a document allows us to access and modify // properties that reference the document-wide data such as styles or lists para.getParagraphFormat().setStyleName("Heading 1"); // Now add the paragraph to the main text of the first section doc.getFirstSection().getBody().appendChild(para); // The paragraph node is now a child of the Body node System.out.println("Paragraph has a parent node: " + (para.getParentNode() != null));
getPreferredWidth/setPreferredWidth | |
public PreferredWidth getPreferredWidth() / public void setPreferredWidth(PreferredWidth value) |
The default value is
Example:
Shows how to set a table to auto fit to 50% of the page width.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a table with a width that takes up half the page width Table table = builder.startTable(); // Insert a few cells builder.insertCell(); table.setPreferredWidth(PreferredWidth.fromPercent(50.0)); builder.writeln("Cell #1"); builder.insertCell(); builder.writeln("Cell #2"); builder.insertCell(); builder.writeln("Cell #3"); doc.save(getArtifactsDir() + "DocumentBuilder.InsertTableWithPreferredWidth.doc");
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling() |
Example:
Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.// Document is a CompositeNode and LastChild returns the last child node in the Document node // Since the Document can contain only Section nodes, the last child is the last section Node lastSection = doc.getLastChild(); // Each node knows its next and previous sibling nodes // Previous sibling of a section is a section before the specified section // If the node is the first child, PreviousSibling will return null Node sectionBeforeLast = lastSection.getPreviousSibling(); if (sectionBeforeLast != null) { doc.removeChild(sectionBeforeLast); }
getRange | → inherited from Node |
public Range getRange() |
Example:
Shows how to delete all characters of a range.// Insert two sections into a blank document Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("Section 1. "); builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS); builder.write("Section 2."); // Verify the whole text of the document Assert.assertEquals("Section 1. \fSection 2.", doc.getText().trim()); // Delete the first section from the document doc.getSections().get(0).getRange().delete(); // Check the first section was deleted by looking at the text of the whole document again Assert.assertEquals("Section 2.", doc.getText().trim());
getRelativeHorizontalAlignment/setRelativeHorizontalAlignment | |
public int getRelativeHorizontalAlignment() / public void setRelativeHorizontalAlignment(int value) |
Example:
Shows how get/set properties for floating tables.Document doc = new Document(getMyDir() + "Table wrapped by text.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); table.setAbsoluteHorizontalDistance(10.0); table.setAbsoluteVerticalDistance(15.0); // Check that absolute distance was set correct Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 10.0); Assert.assertEquals(table.getAbsoluteVerticalDistance(), 15.0); // Setting RelativeHorizontalAlignment will reset AbsoluteHorizontalDistance to default value and vice versa, // the same is for vertical positioning table.setRelativeVerticalAlignment(VerticalAlignment.TOP); table.setRelativeHorizontalAlignment(HorizontalAlignment.CENTER); // Check that AbsoluteHorizontalDistance and AbsoluteVerticalDistance are reset Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0); Assert.assertEquals(table.getAbsoluteVerticalDistance(), 0.0); Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.TOP); Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.CENTER); doc.save(getArtifactsDir() + "Table.ChangeFloatingTableProperties.docx");
getRelativeVerticalAlignment/setRelativeVerticalAlignment | |
public int getRelativeVerticalAlignment() / public void setRelativeVerticalAlignment(int value) |
Example:
Shows how get/set properties for floating tables.Document doc = new Document(getMyDir() + "Table wrapped by text.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); table.setAbsoluteHorizontalDistance(10.0); table.setAbsoluteVerticalDistance(15.0); // Check that absolute distance was set correct Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 10.0); Assert.assertEquals(table.getAbsoluteVerticalDistance(), 15.0); // Setting RelativeHorizontalAlignment will reset AbsoluteHorizontalDistance to default value and vice versa, // the same is for vertical positioning table.setRelativeVerticalAlignment(VerticalAlignment.TOP); table.setRelativeHorizontalAlignment(HorizontalAlignment.CENTER); // Check that AbsoluteHorizontalDistance and AbsoluteVerticalDistance are reset Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0); Assert.assertEquals(table.getAbsoluteVerticalDistance(), 0.0); Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.TOP); Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.CENTER); doc.save(getArtifactsDir() + "Table.ChangeFloatingTableProperties.docx");
getRightPadding/setRightPadding | |
public double getRightPadding() / public void setRightPadding(double value) |
Example:
Shows how to create a table that contains a single cell and apply row formatting.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); builder.insertCell(); // Set the row formatting RowFormat rowFormat = builder.getRowFormat(); rowFormat.setHeight(100); rowFormat.setHeightRule(HeightRule.EXACTLY); // These formatting properties are set on the table and are applied to all rows in the table table.setLeftPadding(30); table.setRightPadding(30); table.setTopPadding(30); table.setBottomPadding(30); builder.writeln("Contents of formatted row."); builder.endRow(); builder.endTable();
getRows | |
public RowCollection getRows() |
Example:
Shows how to combine the rows from two tables into one.// Load the document Document doc = new Document(getMyDir() + "Tables.docx"); // Get the first and second table in the document // The rows from the second table will be appended to the end of the first table Table firstTable = (Table) doc.getChild(NodeType.TABLE, 0, true); Table secondTable = (Table) doc.getChild(NodeType.TABLE, 1, true); // Append all rows from the current table to the next // Due to the design of tables even tables with different cell count and widths can be joined into one table while (secondTable.hasChildNodes()) firstTable.getRows().add(secondTable.getFirstRow()); // Remove the empty table container secondTable.remove(); doc.save(getArtifactsDir() + "Table.CombineTables.doc");
Example:
Shows how to iterate through all tables in the document and display the content from each cell.Document doc = new Document(getMyDir() + "Tables.docx"); // Here we get all tables from the Document node. You can do this for any other composite node // which can contain block level nodes. For example you can retrieve tables from header or from a cell // containing another table (nested tables) TableCollection tables = doc.getFirstSection().getBody().getTables(); // We can make a new array to clone all of the tables in the collection Assert.assertEquals(tables.toArray().length, 2); // Iterate through all tables in the document for (int i = 0; i < tables.getCount(); i++) { // Get the index of the table node as contained in the parent node of the table System.out.println(MessageFormat.format("Start of Table {0}", i)); RowCollection rows = tables.get(i).getRows(); // RowCollections can be cloned into arrays Assert.assertNotSame(rows, rows.toArray()); // Iterate through all rows in the table for (int j = 0; j < rows.getCount(); j++) { System.out.println(MessageFormat.format("\tStart of Row {0}", j)); CellCollection cells = rows.get(j).getCells(); // RowCollections can also be cloned into arrays Assert.assertNotSame(cells, cells.toArray()); // Iterate through all cells in the row for (int k = 0; k < cells.getCount(); k++) { // Get the plain text content of this cell. String cellText = cells.get(k).toString(SaveFormat.TEXT).trim(); // Print the content of the cell. System.out.println(MessageFormat.format("\t\tContents of Cell:{0} = \"{1}\"", k, cellText)); } System.out.println(MessageFormat.format("\tEnd of Row {0}", j)); } System.out.println(MessageFormat.format("End of Table {0}\n", i)); }
getStyle/setStyle | |
public Style getStyle() / public void setStyle(Style value) |
Example:
Shows how to create your own style settings for the table.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); builder.insertCell(); builder.write("Name"); builder.insertCell(); builder.write("??????"); builder.endRow(); builder.insertCell(); builder.insertCell(); builder.endTable(); TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1"); tableStyle.setAllowBreakAcrossPages(true); tableStyle.setBidi(true); tableStyle.setCellSpacing(5.0); tableStyle.setBottomPadding(20.0); tableStyle.setLeftPadding(5.0); tableStyle.setRightPadding(10.0); tableStyle.setTopPadding(20.0); tableStyle.getShading().setBackgroundPatternColor(Color.WHITE); tableStyle.getBorders().setColor(Color.BLACK); tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH); table.setStyle(tableStyle); // Some Table attributes are linked to style variables Assert.assertEquals(table.getBidi(), true); Assert.assertEquals(table.getCellSpacing(), 5.0); Assert.assertEquals(table.getStyleName(), "MyTableStyle1"); doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");
getStyleIdentifier/setStyleIdentifier | |
public int getStyleIdentifier() / public void setStyleIdentifier(int value) |
Example:
Shows how to build a new table with a table style applied.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); // We must insert at least one row first before setting any table formatting builder.insertCell(); // Set the table style used based of the unique style identifier // Note that not all table styles are available when saving as .doc format table.setStyleIdentifier(StyleIdentifier.MEDIUM_SHADING_1_ACCENT_1); // Apply which features should be formatted by the style table.setStyleOptions(TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS | TableStyleOptions.FIRST_ROW); table.autoFit(AutoFitBehavior.AUTO_FIT_TO_CONTENTS); // Continue with building the table as normal builder.writeln("Item"); builder.getCellFormat().setRightPadding(40.0); builder.insertCell(); builder.writeln("Quantity (kg)"); builder.endRow(); builder.insertCell(); builder.writeln("Apples"); builder.insertCell(); builder.writeln("20"); builder.endRow(); builder.insertCell(); builder.writeln("Bananas"); builder.insertCell(); builder.writeln("40"); builder.endRow(); builder.insertCell(); builder.writeln("Carrots"); builder.insertCell(); builder.writeln("50"); builder.endRow(); doc.save(getArtifactsDir() + "DocumentBuilder.InsertTableWithStyle.docx");
getStyleName/setStyleName | |
public java.lang.String getStyleName() / public void setStyleName(java.lang.String value) |
Example:
Shows how to create your own style settings for the table.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); builder.insertCell(); builder.write("Name"); builder.insertCell(); builder.write("??????"); builder.endRow(); builder.insertCell(); builder.insertCell(); builder.endTable(); TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1"); tableStyle.setAllowBreakAcrossPages(true); tableStyle.setBidi(true); tableStyle.setCellSpacing(5.0); tableStyle.setBottomPadding(20.0); tableStyle.setLeftPadding(5.0); tableStyle.setRightPadding(10.0); tableStyle.setTopPadding(20.0); tableStyle.getShading().setBackgroundPatternColor(Color.WHITE); tableStyle.getBorders().setColor(Color.BLACK); tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH); table.setStyle(tableStyle); // Some Table attributes are linked to style variables Assert.assertEquals(table.getBidi(), true); Assert.assertEquals(table.getCellSpacing(), 5.0); Assert.assertEquals(table.getStyleName(), "MyTableStyle1"); doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");
getStyleOptions/setStyleOptions | |
public int getStyleOptions() / public void setStyleOptions(int value) |
Example:
Shows how to build a new table with a table style applied.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); // We must insert at least one row first before setting any table formatting builder.insertCell(); // Set the table style used based of the unique style identifier // Note that not all table styles are available when saving as .doc format table.setStyleIdentifier(StyleIdentifier.MEDIUM_SHADING_1_ACCENT_1); // Apply which features should be formatted by the style table.setStyleOptions(TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS | TableStyleOptions.FIRST_ROW); table.autoFit(AutoFitBehavior.AUTO_FIT_TO_CONTENTS); // Continue with building the table as normal builder.writeln("Item"); builder.getCellFormat().setRightPadding(40.0); builder.insertCell(); builder.writeln("Quantity (kg)"); builder.endRow(); builder.insertCell(); builder.writeln("Apples"); builder.insertCell(); builder.writeln("20"); builder.endRow(); builder.insertCell(); builder.writeln("Bananas"); builder.insertCell(); builder.writeln("40"); builder.endRow(); builder.insertCell(); builder.writeln("Carrots"); builder.insertCell(); builder.writeln("50"); builder.endRow(); doc.save(getArtifactsDir() + "DocumentBuilder.InsertTableWithStyle.docx");
getTextWrapping/setTextWrapping | |
public int getTextWrapping() / public void setTextWrapping(int value) |
Example:
Shows how to work with table text wrapping.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = DocumentHelper.insertTable(builder); if (table.getTextWrapping() == TextWrapping.AROUND) { Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.DEFAULT); Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.DEFAULT); Assert.assertEquals(table.getHorizontalAnchor(), RelativeHorizontalPosition.COLUMN); Assert.assertEquals(table.getVerticalAnchor(), RelativeVerticalPosition.MARGIN); Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0); Assert.assertEquals(table.getAbsoluteVerticalDistance(), 0); Assert.assertEquals(table.getAllowOverlap(), true); }
getTitle/setTitle | |
public java.lang.String getTitle() / public void setTitle(java.lang.String value) |
The default value is an empty string.
This property is meaningful for ISO/IEC 29500 compliant DOCX documents
(
Example:
Shows how to build a nested table without using DocumentBuilder.public void createNestedTable() throws Exception { Document doc = new Document(); // Create the outer table with three rows and four columns Table outerTable = createTable(doc, 3, 4, "Outer Table"); // Add it to the document body doc.getFirstSection().getBody().appendChild(outerTable); // Create another table with two rows and two columns Table innerTable = createTable(doc, 2, 2, "Inner Table"); // Add this table to the first cell of the outer table outerTable.getFirstRow().getFirstCell().appendChild(innerTable); doc.save(getArtifactsDir() + "Table.CreateNestedTable.doc"); } /** * Creates a new table in the document with the given dimensions and text in each cell. */ private Table createTable(final Document doc, final int rowCount, final int cellCount, final String cellText) throws Exception { Table table = new Table(doc); // Create the specified number of rows for (int rowId = 1; rowId <= rowCount; rowId++) { Row row = new Row(doc); table.appendChild(row); // Create the specified number of cells for each row for (int cellId = 1; cellId <= cellCount; cellId++) { Cell cell = new Cell(doc); row.appendChild(cell); // Add a blank paragraph to the cell cell.appendChild(new Paragraph(doc)); // Add the text cell.getFirstParagraph().appendChild(new Run(doc, cellText)); } } // You can add title and description to your table only when added at least one row to the table first // This properties are meaningful for ISO / IEC 29500 compliant DOCX documents(see the OoxmlCompliance class) // When saved to pre-ISO/IEC 29500 formats, the properties are ignored table.setTitle("Aspose table title"); table.setDescription("Aspose table description"); return table; }
getTopPadding/setTopPadding | |
public double getTopPadding() / public void setTopPadding(double value) |
Example:
Shows how to create a table that contains a single cell and apply row formatting.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); builder.insertCell(); // Set the row formatting RowFormat rowFormat = builder.getRowFormat(); rowFormat.setHeight(100); rowFormat.setHeightRule(HeightRule.EXACTLY); // These formatting properties are set on the table and are applied to all rows in the table table.setLeftPadding(30); table.setRightPadding(30); table.setTopPadding(30); table.setBottomPadding(30); builder.writeln("Contents of formatted row."); builder.endRow(); builder.endTable();
getVerticalAnchor/setVerticalAnchor | |
public int getVerticalAnchor() / public void setVerticalAnchor(int value) |
Example:
Shows how get properties for floating tables.Document doc = new Document(getMyDir() + "Table wrapped by text.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); if (table.getTextWrapping() == TextWrapping.AROUND) { Assert.assertEquals(table.getRelativeHorizontalAlignment(), HorizontalAlignment.CENTER); Assert.assertEquals(table.getRelativeVerticalAlignment(), VerticalAlignment.DEFAULT); Assert.assertEquals(table.getHorizontalAnchor(), RelativeHorizontalPosition.MARGIN); Assert.assertEquals(table.getVerticalAnchor(), RelativeVerticalPosition.PARAGRAPH); Assert.assertEquals(table.getAbsoluteHorizontalDistance(), 0.0); Assert.assertEquals(table.getAbsoluteVerticalDistance(), 56.15); Assert.assertEquals(table.getAllowOverlap(), false); }
Method Detail |
---|
accept | |
public boolean accept(DocumentVisitor visitor) throws java.lang.Exception |
Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.
For more info see the Visitor design pattern.
visitor
- The visitor that will visit the nodes.Example:
Implements the Visitor Pattern to remove all content formatted as hidden from the document.public void removeHiddenContentFromDocument() throws Exception { // Open the document we want to remove hidden content from Document doc = new Document(getMyDir() + "Hidden content.docx"); // Create an object that inherits from the DocumentVisitor class RemoveHiddenContentVisitor hiddenContentRemover = new RemoveHiddenContentVisitor(); // This is the well known Visitor pattern. Get the model to accept a visitor // The model will iterate through itself by calling the corresponding methods // on the visitor object (this is called visiting) // We can run it over the entire the document like so doc.accept(hiddenContentRemover); // Or we can run it on only a specific node Paragraph para = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 4, true); para.accept(hiddenContentRemover); // Or over a different type of node like below Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); table.accept(hiddenContentRemover); doc.save(getArtifactsDir() + "Font.RemoveHiddenContentFromDocument.doc"); } /** * This class when executed will remove all hidden content from the Document. Implemented as a Visitor. */ private class RemoveHiddenContentVisitor extends DocumentVisitor { /** * Called when a FieldStart node is encountered in the document. */ public int visitFieldStart(final FieldStart fieldStart) throws Exception { // If this node is hidden, then remove it if (isHidden(fieldStart)) { fieldStart.remove(); } return VisitorAction.CONTINUE; } /** * Called when a FieldEnd node is encountered in the document. */ public int visitFieldEnd(final FieldEnd fieldEnd) throws Exception { if (isHidden(fieldEnd)) { fieldEnd.remove(); } return VisitorAction.CONTINUE; } /** * Called when a FieldSeparator node is encountered in the document. */ public int visitFieldSeparator(final FieldSeparator fieldSeparator) throws Exception { if (isHidden(fieldSeparator)) { fieldSeparator.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Run node is encountered in the document. */ public int visitRun(final Run run) throws Exception { if (isHidden(run)) { run.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Paragraph node is encountered in the document. */ public int visitParagraphStart(final Paragraph paragraph) throws Exception { if (isHidden(paragraph)) { paragraph.remove(); } return VisitorAction.CONTINUE; } /** * Called when a FormField is encountered in the document. */ public int visitFormField(final FormField field) throws Exception { if (isHidden(field)) { field.remove(); } return VisitorAction.CONTINUE; } /** * Called when a GroupShape is encountered in the document. */ public int visitGroupShapeStart(final GroupShape groupShape) throws Exception { if (isHidden(groupShape)) { groupShape.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Shape is encountered in the document. */ public int visitShapeStart(final Shape shape) throws Exception { if (isHidden(shape)) { shape.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Comment is encountered in the document. */ public int visitCommentStart(final Comment comment) throws Exception { if (isHidden(comment)) { comment.remove(); } return VisitorAction.CONTINUE; } /** * Called when a Footnote is encountered in the document. */ public int visitFootnoteStart(final Footnote footnote) throws Exception { if (isHidden(footnote)) { footnote.remove(); } return VisitorAction.CONTINUE; } /** * Called when visiting of a Table node is ended in the document. */ public int visitTableEnd(final Table table) { // At the moment there is no way to tell if a particular Table/Row/Cell is hidden. // Instead, if the content of a table is hidden, then all inline child nodes of the table should be // hidden and thus removed by previous visits as well. This will result in the container being empty // so if this is the case we know to remove the table node. // // Note that a table which is not hidden but simply has no content will not be affected by this algorithm, // as technically they are not completely empty (for example a properly formed Cell will have at least // an empty paragraph in it) if (!table.hasChildNodes()) { table.remove(); } return VisitorAction.CONTINUE; } /** * Called when visiting of a Cell node is ended in the document. */ public int visitCellEnd(final Cell cell) { if (!cell.hasChildNodes() && cell.getParentNode() != null) { cell.remove(); } return VisitorAction.CONTINUE; } /** * Called when visiting of a Row node is ended in the document. */ public int visitRowEnd(final Row row) { if (!row.hasChildNodes() && row.getParentNode() != null) { row.remove(); } return VisitorAction.CONTINUE; } /** * Called when a SpecialCharacter is encountered in the document. */ public int visitSpecialChar(final SpecialChar character) throws Exception { if (isHidden(character)) { character.remove(); } return VisitorAction.CONTINUE; } /** * Returns true if the node passed is set as hidden, returns false if it is visible. */ private boolean isHidden(final Node node) { if (node instanceof Inline) { // If the node is Inline then cast it to retrieve the Font property which contains the hidden property Inline currentNode = (Inline) node; return currentNode.getFont().getHidden(); } else if (node.getNodeType() == NodeType.PARAGRAPH) { // If the node is a paragraph cast it to retrieve the ParagraphBreakFont which contains the hidden property Paragraph para = (Paragraph) node; return para.getParagraphBreakFont().getHidden(); } else if (node instanceof ShapeBase) { // Node is a shape or groupshape ShapeBase shape = (ShapeBase) node; return shape.getFont().getHidden(); } else if (node instanceof InlineStory) { // Node is a comment or footnote InlineStory inlineStory = (InlineStory) node; return inlineStory.getFont().getHidden(); } // A node that is passed to this method which does not contain a hidden property will end up here // By default nodes are not hidden so return false return false; } }
appendChild | → inherited from CompositeNode |
public Node appendChild(Node newChild) |
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The node to add.Example:
Creates a simple document from scratch using the Aspose.Words object model.// Create an "empty" document. Note that like in Microsoft Word, // the empty document has one section, body and one paragraph in it Document doc = new Document(); // This truly makes the document empty. No sections (not possible in Microsoft Word) doc.removeAllChildren(); // Create a new section node // Note that the section has not yet been added to the document, // but we have to specify the parent document Section section = new Section(doc); // Append the section to the document doc.appendChild(section); // Lets set some properties for the section section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE); section.getPageSetup().setPaperSize(PaperSize.LETTER); // The section that we created is empty, lets populate it. The section needs at least the Body node Body body = new Body(doc); section.appendChild(body); // The body needs to have at least one paragraph // Note that the paragraph has not yet been added to the document, // but we have to specify the parent document // The parent document is needed so the paragraph can correctly work // with styles and other document-wide information Paragraph para = new Paragraph(doc); body.appendChild(para); // We can set some formatting for the paragraph para.getParagraphFormat().setStyleName("Heading 1"); para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER); // So far we have one empty paragraph in the document // The document is valid and can be saved, but lets add some text before saving // Create a new run of text and add it to our paragraph Run run = new Run(doc); run.setText("Hello World!"); run.getFont().setColor(Color.RED); para.appendChild(run); // As a matter of interest, you can retrieve text of the whole document and // see that \x000c is automatically appended. \x000c is the end of section character System.out.println(doc.getText()); // Save the document doc.save(getArtifactsDir() + "Section.CreateFromScratch.doc");
autoFit | |
public void autoFit(int behavior) throws java.lang.Exception |
This method mimics the commands available in the Auto Fit menu for a table in Microsoft Word. The commands available are "Auto Fit to Contents", "Auto Fit to Window" and "Fixed Column Width". In Microsoft Word these commands set relevant table properties and then update the table layout and Aspose.Words does the same for you.
behavior
- A Example:
Shows how to build a new table with a table style applied.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); // We must insert at least one row first before setting any table formatting builder.insertCell(); // Set the table style used based of the unique style identifier // Note that not all table styles are available when saving as .doc format table.setStyleIdentifier(StyleIdentifier.MEDIUM_SHADING_1_ACCENT_1); // Apply which features should be formatted by the style table.setStyleOptions(TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS | TableStyleOptions.FIRST_ROW); table.autoFit(AutoFitBehavior.AUTO_FIT_TO_CONTENTS); // Continue with building the table as normal builder.writeln("Item"); builder.getCellFormat().setRightPadding(40.0); builder.insertCell(); builder.writeln("Quantity (kg)"); builder.endRow(); builder.insertCell(); builder.writeln("Apples"); builder.insertCell(); builder.writeln("20"); builder.endRow(); builder.insertCell(); builder.writeln("Bananas"); builder.insertCell(); builder.writeln("40"); builder.endRow(); builder.insertCell(); builder.writeln("Carrots"); builder.insertCell(); builder.writeln("50"); builder.endRow(); doc.save(getArtifactsDir() + "DocumentBuilder.InsertTableWithStyle.docx");
Example:
Shows how to build a formatted table that contains 2 rows and 2 columns.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); // Insert a cell builder.insertCell(); // Use fixed column widths table.autoFit(AutoFitBehavior.FIXED_COLUMN_WIDTHS); builder.getCellFormat().setVerticalAlignment(CellVerticalAlignment.CENTER); builder.write("This is row 1 cell 1"); // Insert a cell builder.insertCell(); builder.write("This is row 1 cell 2"); builder.endRow(); // Insert a cell builder.insertCell(); // Apply new row formatting builder.getRowFormat().setHeight(100); builder.getRowFormat().setHeightRule(HeightRule.EXACTLY); builder.getCellFormat().setOrientation(TextOrientation.UPWARD); builder.writeln("This is row 2 cell 1"); // Insert a cell builder.insertCell(); builder.getCellFormat().setOrientation(TextOrientation.DOWNWARD); builder.writeln("This is row 2 cell 2"); builder.endRow(); builder.endTable();
clearBorders | |
public void clearBorders() |
Example:
Shows how to apply a outline border to a table.Document doc = new Document(getMyDir() + "Tables.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); // Align the table to the center of the page table.setAlignment(TableAlignment.CENTER); // Clear any existing borders and shading from the table table.clearBorders(); table.clearShading(); // Set a green border around the table but not inside table.setBorder(BorderType.LEFT, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.RIGHT, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.TOP, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.BOTTOM, LineStyle.SINGLE, 1.5, Color.GREEN, true); // Fill the cells with a light green solid color table.setShading(TextureIndex.TEXTURE_SOLID, Color.GREEN, Color.GREEN); doc.save(getArtifactsDir() + "Table.SetOutlineBorders.docx");
Example:
Shows how to remove all borders from a table.Document doc = new Document(getMyDir() + "Tables.docx"); // Remove all borders from the first table in the document Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); // Clear the borders all cells in the table table.clearBorders(); doc.save(getArtifactsDir() + "Table.ClearBorders.doc");
clearShading | |
public void clearShading() |
Example:
Shows how to apply a outline border to a table.Document doc = new Document(getMyDir() + "Tables.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); // Align the table to the center of the page table.setAlignment(TableAlignment.CENTER); // Clear any existing borders and shading from the table table.clearBorders(); table.clearShading(); // Set a green border around the table but not inside table.setBorder(BorderType.LEFT, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.RIGHT, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.TOP, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.BOTTOM, LineStyle.SINGLE, 1.5, Color.GREEN, true); // Fill the cells with a light green solid color table.setShading(TextureIndex.TEXTURE_SOLID, Color.GREEN, Color.GREEN); doc.save(getArtifactsDir() + "Table.SetOutlineBorders.docx");
convertToHorizontallyMergedCells | |
public void convertToHorizontallyMergedCells() |
Table cells can be horizontally merged either using merge flags
When table cell is merged by width property
Use this method to transforms table cells horizontally merged by width to cells merged by merge flags.
Example:
Shows how to convert cells horizontally merged by width to cells merged by CellFormat.HorizontalMerge.Document doc = new Document(getMyDir() + "Table with merged cells.docx"); // MS Word does not write merge flags anymore, they define merged cells by its width // So AW by default define only 5 cells in a row and all of it didn't have horizontal merge flag Table table = doc.getFirstSection().getBody().getTables().get(0); Row row = table.getRows().get(0); Assert.assertEquals(row.getCells().getCount(), 5); // To resolve this inconvenience, we have added new public method to convert cells which are horizontally merged // by its width to the cell horizontally merged by flags. Thus now we have 7 cells and some of them have // horizontal merge value table.convertToHorizontallyMergedCells(); row = table.getRows().get(0); Assert.assertEquals(row.getCells().getCount(), 7); Assert.assertEquals(row.getCells().get(0).getCellFormat().getHorizontalMerge(), CellMerge.NONE); Assert.assertEquals(row.getCells().get(1).getCellFormat().getHorizontalMerge(), CellMerge.FIRST); Assert.assertEquals(row.getCells().get(2).getCellFormat().getHorizontalMerge(), CellMerge.PREVIOUS); Assert.assertEquals(row.getCells().get(3).getCellFormat().getHorizontalMerge(), CellMerge.NONE); Assert.assertEquals(row.getCells().get(4).getCellFormat().getHorizontalMerge(), CellMerge.FIRST); Assert.assertEquals(row.getCells().get(5).getCellFormat().getHorizontalMerge(), CellMerge.PREVIOUS); Assert.assertEquals(row.getCells().get(6).getCellFormat().getHorizontalMerge(), CellMerge.NONE);
deepClone | → inherited from Node |
public Node deepClone(boolean isCloneChildren) |
Example:
Shows how to clone composite nodes with and without their child nodes.// Create a new empty document Document doc = new Document(); // Add some text to the first paragraph Paragraph para = doc.getFirstSection().getBody().getFirstParagraph(); para.appendChild(new Run(doc, "Some text")); // Clone the paragraph and the child nodes Node cloneWithChildren = para.deepClone(true); // Only clone the paragraph and no child nodes Node cloneWithoutChildren = para.deepClone(false);
ensureMinimum | |
public void ensureMinimum() |
Example:
Shows how to ensure a table node is valid.Document doc = new Document(); // Create a new table and add it to the document Table table = new Table(doc); doc.getFirstSection().getBody().appendChild(table); // Ensure the table is valid (has at least one row with one cell) table.ensureMinimum();
getAncestor | → inherited from Node |
public CompositeNode getAncestor(int ancestorType) |
ancestorType
- A Example:
Shows how to find out if a table contains another table or if the table itself is nested inside another table.public void calculateDepthOfNestedTables() throws Exception { Document doc = new Document(getMyDir() + "Nested tables.docx"); int tableIndex = 0; for (Table table : (Iterable<Table>) doc.getChildNodes(NodeType.TABLE, true)) { // First lets find if any cells in the table have tables themselves as children int count = getChildTableCount(table); System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", tableIndex, count)); // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth int tableDepth = getNestedDepthOfTable(table); if (tableDepth > 0) { System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", tableIndex, tableDepth)); } else { System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", tableIndex)); } tableIndex++; } } /** * Calculates what level a table is nested inside other tables. * * @returns An integer containing the level the table is nested at. * 0 = Table is not nested inside any other table * 1 = Table is nested within one parent table * 2 = Table is nested within two parent tables etc.. */ private static int getNestedDepthOfTable(final Table table) { int depth = 0; int type = table.getNodeType(); // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table Node parent = table.getAncestor(table.getNodeType()); while (parent != null) { // Every time we find a table a level up we increase the depth counter and then try to find an // ancestor of type table from the parent depth++; parent = parent.getAncestor(Table.class); } return depth; } /** * Determines if a table contains any immediate child table within its cells. * Does not recursively traverse through those tables to check for further tables. * * @returns Returns true if at least one child cell contains a table. * Returns false if no cells in the table contains a table. */ private static int getChildTableCount(final Table table) { int tableCount = 0; // Iterate through all child rows in the table for (Row row : table.getRows()) { // Iterate through all child cells in the row for (Cell cell : row.getCells()) { // Retrieve the collection of child tables of this cell TableCollection childTables = cell.getTables(); // If this cell has a table as a child then return true if (childTables.getCount() > 0) tableCount++; } } // No cell contains a table return tableCount; }
getAncestor | → inherited from Node |
public CompositeNode getAncestor(java.lang.Class ancestorType) |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The object type of the ancestor to retrieve.Example:
Shows how to find out if a table contains another table or if the table itself is nested inside another table.public void calculateDepthOfNestedTables() throws Exception { Document doc = new Document(getMyDir() + "Nested tables.docx"); int tableIndex = 0; for (Table table : (Iterable<Table>) doc.getChildNodes(NodeType.TABLE, true)) { // First lets find if any cells in the table have tables themselves as children int count = getChildTableCount(table); System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", tableIndex, count)); // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth int tableDepth = getNestedDepthOfTable(table); if (tableDepth > 0) { System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", tableIndex, tableDepth)); } else { System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", tableIndex)); } tableIndex++; } } /** * Calculates what level a table is nested inside other tables. * * @returns An integer containing the level the table is nested at. * 0 = Table is not nested inside any other table * 1 = Table is nested within one parent table * 2 = Table is nested within two parent tables etc.. */ private static int getNestedDepthOfTable(final Table table) { int depth = 0; int type = table.getNodeType(); // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table Node parent = table.getAncestor(table.getNodeType()); while (parent != null) { // Every time we find a table a level up we increase the depth counter and then try to find an // ancestor of type table from the parent depth++; parent = parent.getAncestor(Table.class); } return depth; } /** * Determines if a table contains any immediate child table within its cells. * Does not recursively traverse through those tables to check for further tables. * * @returns Returns true if at least one child cell contains a table. * Returns false if no cells in the table contains a table. */ private static int getChildTableCount(final Table table) { int tableCount = 0; // Iterate through all child rows in the table for (Row row : table.getRows()) { // Iterate through all child cells in the row for (Cell cell : row.getCells()) { // Retrieve the collection of child tables of this cell TableCollection childTables = cell.getTables(); // If this cell has a table as a child then return true if (childTables.getCount() > 0) tableCount++; } } // No cell contains a table return tableCount; }
getChild | → inherited from CompositeNode |
public Node getChild(int nodeType, int index, boolean isDeep) |
If index is out of range, a null is returned.
nodeType
- A index
- Zero based index of the child node to select.
Negative indexes are also allowed and indicate access from the end,
that is -1 means the last node.isDeep
- True to select from all child nodes recursively.
False to select only among immediate children. See remarks for more info.Example:
Shows how to test if a node is inside a field by using an XPath expression.// Let's pick a document we know has some fields in Document doc = new Document(getMyDir() + "Mail merge destination - Northwind employees.docx"); // Let's say we want to check if the Run below is inside a field Run run = (Run) doc.getChild(NodeType.RUN, 5, true); // Evaluate the XPath expression. The resulting NodeList will contain all nodes found inside a field a field (between FieldStart // and FieldEnd exclusive). There can however be FieldStart and FieldEnd nodes in the list if there are nested fields // in the path. Currently does not find rare fields in which the FieldCode or FieldResult spans across multiple paragraphs NodeList resultList = doc.selectNodes("//FieldStart/following-sibling::node()[following-sibling::FieldEnd]"); // Check if the specified run is one of the nodes that are inside the field for (Node node : (Iterable<Node>) resultList) { if (node == run) { System.out.println("The node is found inside a field"); break; } }
Example:
Shows how to extract a specific child node from a CompositeNode by using the GetChild method and passing the NodeType and index.Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes(int nodeType, boolean isDeep) |
The collection of nodes returned by this method is always live.
A live collection is always in sync with the document. For example, if you selected all sections in a document and enumerate through the collection deleting the sections, the section is removed from the collection immediately when it is removed from the document.
nodeType
- A isDeep
- True to select from all child nodes recursively.
False to select only among immediate children. Example:
Shows how to get all comments with all replies.Document doc = new Document(getMyDir() + "Comments.docx"); // Get all comment from the document NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true); // For all comments and replies we identify comment level and info about it for (Comment comment : (Iterable<Comment>) comments) { if (comment.getAncestor() == null) { System.out.println("\nThis is a top-level comment"); System.out.println("Comment author: " + comment.getAuthor()); System.out.println("Comment text: " + comment.getText()); for (Comment commentReply : comment.getReplies()) { System.out.println("\n\tThis is a comment reply"); System.out.println("\tReply author: " + commentReply.getAuthor()); System.out.println("\tReply text: " + commentReply.getText()); } } }
Example:
Shows how to extract images from a document and save them as files.public void extractImagesToFiles() throws Exception { Document doc = new Document(getMyDir() + "Images.docx"); NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true); int imageIndex = 0; for (Shape shape : (Iterable<Shape>) shapes) { if (shape.hasImage()) { String imageFileName = MessageFormat.format("File.ExtractImagesToFiles.{0}{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType())); shape.getImageData().save(getArtifactsDir() + imageFileName); imageIndex++; } } }
Example:
Demonstrates how to remove a specified TOC from a document.// Open a document which contains a TOC Document doc = new Document(getMyDir() + "Table of contents.docx"); // Remove the first TOC from the document Field tocField = doc.getRange().getFields().get(0); tocField.remove(); // Save the output doc.save(getArtifactsDir() + "Field.RemoveTocFromDocument.docx");
getText | → inherited from CompositeNode |
public java.lang.String getText() |
The returned string includes all control and special characters as described in
Example:
Shows the difference between calling the GetText and ToString methods on a node.Document doc = new Document(); // Enter a field into the document DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField("MERGEFIELD Field"); // GetText will retrieve all field codes and special characters Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText()); // ToString will give us the plaintext version of the document in the save format we put into the parameter Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));
Example:
Finds and outputs all paragraphs in a document that are bulleted or numbered.NodeCollection paras = doc.getChildNodes(NodeType.PARAGRAPH, true); for (Paragraph para : (Iterable<Paragraph>) paras) { if (para.getListFormat().isListItem()) { System.out.println(java.text.MessageFormat.format("*** A paragraph belongs to list {0}", para.getListFormat().getList().getListId())); System.out.println(para.getText()); } }
indexOf | → inherited from CompositeNode |
public int indexOf(Node child) |
Example:
Shows how to get the index of a given child node from its parent.Document doc = new Document(getMyDir() + "Rendering.docx"); // Get the body of the first section in the document Body body = doc.getFirstSection().getBody(); // Retrieve the index of the last paragraph in the body int index = body.getChildNodes().indexOf(body.getLastParagraph());
insertAfter | → inherited from CompositeNode |
public Node insertAfter(Node newChild, Node refChild) |
If refChild is null, inserts newChild at the beginning of the list of child nodes.
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newNode is placed after the refNode. Example:
Shows how to add, update and delete child nodes from within a CompositeNode.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1); // A paragraph is a composite node because it can contain runs, which are another type of node Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph(); Run paragraphText = new Run(doc, "Initial text. "); paragraph.appendChild(paragraphText); // We will place these 3 children into the main text of our paragraph Run run1 = new Run(doc, "Run 1. "); Run run2 = new Run(doc, "Run 2. "); Run run3 = new Run(doc, "Run 3. "); // We initialized them but not in our paragraph yet Assert.assertEquals(paragraph.getText(), "Initial text. " + (char) 12); // Insert run2 before initial paragraph text. This will be at the start of the paragraph paragraph.insertBefore(run2, paragraphText); // Insert run3 after initial paragraph text. This will be at the end of the paragraph paragraph.insertAfter(run3, paragraphText); // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1 paragraph.prependChild(run1); Assert.assertEquals(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4); // Access the child node collection and update/delete children ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. "); paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText); Assert.assertEquals(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);
Example:
Shows how to replace all textboxes with images.Document doc = new Document(getMyDir() + "Textboxes in drawing canvas.docx"); // This gets a live collection of all shape nodes in the document NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true); // Since we will be adding/removing nodes, it is better to copy all collection // into a fixed size array, otherwise iterator will be invalidated Node[] shapes = shapeCollection.toArray(); for (Node node : shapes) { Shape shape = (Shape) node; // Filter out all shapes that we don't need if (shape.getShapeType() == ShapeType.TEXT_BOX) { // Create a new shape that will replace the existing shape Shape image = new Shape(doc, ShapeType.IMAGE); // Load the image into the new shape image.getImageData().setImage(getImageDir() + "Windows MetaFile.wmf"); // Make new shape's position to match the old shape image.setLeft(shape.getLeft()); image.setTop(shape.getTop()); image.setWidth(shape.getWidth()); image.setHeight(shape.getHeight()); image.setRelativeHorizontalPosition(shape.getRelativeHorizontalPosition()); image.setRelativeVerticalPosition(shape.getRelativeVerticalPosition()); image.setHorizontalAlignment(shape.getHorizontalAlignment()); image.setVerticalAlignment(shape.getVerticalAlignment()); image.setWrapType(shape.getWrapType()); image.setWrapSide(shape.getWrapSide()); // Insert new shape after the old shape and remove the old shape shape.getParentNode().insertAfter(image, shape); shape.remove(); } } doc.save(getArtifactsDir() + "Shape.ReplaceTextboxesWithImages.doc");
insertBefore | → inherited from CompositeNode |
public Node insertBefore(Node newChild, Node refChild) |
If refChild is null, inserts newChild at the end of the list of child nodes.
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newChild is placed before this node.Example:
Shows how to add, update and delete child nodes from within a CompositeNode.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1); // A paragraph is a composite node because it can contain runs, which are another type of node Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph(); Run paragraphText = new Run(doc, "Initial text. "); paragraph.appendChild(paragraphText); // We will place these 3 children into the main text of our paragraph Run run1 = new Run(doc, "Run 1. "); Run run2 = new Run(doc, "Run 2. "); Run run3 = new Run(doc, "Run 3. "); // We initialized them but not in our paragraph yet Assert.assertEquals(paragraph.getText(), "Initial text. " + (char) 12); // Insert run2 before initial paragraph text. This will be at the start of the paragraph paragraph.insertBefore(run2, paragraphText); // Insert run3 after initial paragraph text. This will be at the end of the paragraph paragraph.insertAfter(run3, paragraphText); // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1 paragraph.prependChild(run1); Assert.assertEquals(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4); // Access the child node collection and update/delete children ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. "); paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText); Assert.assertEquals(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);
iterator | → inherited from CompositeNode |
public java.util.Iterator<Node> iterator() |
Example:
Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.NodeCollection children = paragraph.getChildNodes(); for (Node child : (Iterable<Node>) children) { // Paragraph may contain children of various types such as runs, shapes and so on if (child.getNodeType() == NodeType.RUN) { // Say we found the node that we want, do something useful Run run = (Run) child; System.out.println(run.getText()); } }
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.Example:
Shows how to delete all images from a document using pre-order tree traversal.Document doc = new Document(getMyDir() + "Images.docx"); Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10); Node curNode = doc; while (curNode != null) { Node nextNode = curNode.nextPreOrder(doc); if (curNode.previousPreOrder(doc) != null && nextNode != null) { Assert.assertEquals(curNode, nextNode.previousPreOrder(doc)); } if (curNode.getNodeType() == NodeType.SHAPE) { Shape shape = (Shape) curNode; // Several shape types can have an image including image shapes and OLE objects if (shape.hasImage()) { shape.remove(); } } curNode = nextNode; } Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount()); doc.save(getArtifactsDir() + "Image.DeleteAllImagesPreOrder.docx");
prependChild | → inherited from CompositeNode |
public Node prependChild(Node newChild) |
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The node to add.Example:
Shows how to add, update and delete child nodes from within a CompositeNode.Document doc = new Document(); // An empty document has one paragraph by default Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1); // A paragraph is a composite node because it can contain runs, which are another type of node Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph(); Run paragraphText = new Run(doc, "Initial text. "); paragraph.appendChild(paragraphText); // We will place these 3 children into the main text of our paragraph Run run1 = new Run(doc, "Run 1. "); Run run2 = new Run(doc, "Run 2. "); Run run3 = new Run(doc, "Run 3. "); // We initialized them but not in our paragraph yet Assert.assertEquals(paragraph.getText(), "Initial text. " + (char) 12); // Insert run2 before initial paragraph text. This will be at the start of the paragraph paragraph.insertBefore(run2, paragraphText); // Insert run3 after initial paragraph text. This will be at the end of the paragraph paragraph.insertAfter(run3, paragraphText); // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1 paragraph.prependChild(run1); Assert.assertEquals(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4); // Access the child node collection and update/delete children ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. "); paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText); Assert.assertEquals(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12); Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);
previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.Example:
Shows how to delete all images from a document using pre-order tree traversal.Document doc = new Document(getMyDir() + "Images.docx"); Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10); Node curNode = doc; while (curNode != null) { Node nextNode = curNode.nextPreOrder(doc); if (curNode.previousPreOrder(doc) != null && nextNode != null) { Assert.assertEquals(curNode, nextNode.previousPreOrder(doc)); } if (curNode.getNodeType() == NodeType.SHAPE) { Shape shape = (Shape) curNode; // Several shape types can have an image including image shapes and OLE objects if (shape.hasImage()) { shape.remove(); } } curNode = nextNode; } Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount()); doc.save(getArtifactsDir() + "Image.DeleteAllImagesPreOrder.docx");
remove | → inherited from Node |
public void remove() |
Example:
Shows how to delete all images from a document.Document doc = new Document(getMyDir() + "Images.docx"); Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10); // Here we get all shapes from the document node, but you can do this for any smaller // node too, for example delete shapes from a single section or a paragraph NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true); // We cannot delete shape nodes while we enumerate through the collection // One solution is to add nodes that we want to delete to a temporary array and delete afterwards ArrayList shapesToDelete = new ArrayList(); for (Shape shape : (Iterable<Shape>) shapes) { // Several shape types can have an image including image shapes and OLE objects if (shape.hasImage()) { shapesToDelete.add(shape); } } // Now we can delete shapes for (Shape shape : (Iterable<Shape>) shapesToDelete) { shape.remove(); } Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount()); doc.save(getArtifactsDir() + "Image.DeleteAllImages.docx");
Example:
Shows how to remove all nodes of a specific type from a composite node.// In this example we remove tables from a section body // Get the section that we want to work on Section section = doc.getSections().get(0); Body body = section.getBody(); // Select the first child node in the body Node curNode = body.getFirstChild(); while (curNode != null) { // Save the pointer to the next sibling node because if the current // node is removed from the parent in the next step, we will have // no way of finding the next node to continue the loop Node nextNode = curNode.getNextSibling(); // A section body can contain Paragraph and Table nodes // If the node is a Table, remove it from the parent if (curNode.getNodeType() == NodeType.TABLE) { curNode.remove(); } // Continue going through child nodes until null (no more siblings) is reached curNode = nextNode; }
removeAllChildren | → inherited from CompositeNode |
public void removeAllChildren() |
Example:
Creates a simple document from scratch using the Aspose.Words object model.// Create an "empty" document. Note that like in Microsoft Word, // the empty document has one section, body and one paragraph in it Document doc = new Document(); // This truly makes the document empty. No sections (not possible in Microsoft Word) doc.removeAllChildren(); // Create a new section node // Note that the section has not yet been added to the document, // but we have to specify the parent document Section section = new Section(doc); // Append the section to the document doc.appendChild(section); // Lets set some properties for the section section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE); section.getPageSetup().setPaperSize(PaperSize.LETTER); // The section that we created is empty, lets populate it. The section needs at least the Body node Body body = new Body(doc); section.appendChild(body); // The body needs to have at least one paragraph // Note that the paragraph has not yet been added to the document, // but we have to specify the parent document // The parent document is needed so the paragraph can correctly work // with styles and other document-wide information Paragraph para = new Paragraph(doc); body.appendChild(para); // We can set some formatting for the paragraph para.getParagraphFormat().setStyleName("Heading 1"); para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER); // So far we have one empty paragraph in the document // The document is valid and can be saved, but lets add some text before saving // Create a new run of text and add it to our paragraph Run run = new Run(doc); run.setText("Hello World!"); run.getFont().setColor(Color.RED); para.appendChild(run); // As a matter of interest, you can retrieve text of the whole document and // see that \x000c is automatically appended. \x000c is the end of section character System.out.println(doc.getText()); // Save the document doc.save(getArtifactsDir() + "Section.CreateFromScratch.doc");
removeChild | → inherited from CompositeNode |
public Node removeChild(Node oldChild) |
The parent of oldChild is set to null after the node is removed.
oldChild
- The node to remove.Example:
Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.// Document is a CompositeNode and LastChild returns the last child node in the Document node // Since the Document can contain only Section nodes, the last child is the last section Node lastSection = doc.getLastChild(); // Each node knows its next and previous sibling nodes // Previous sibling of a section is a section before the specified section // If the node is the first child, PreviousSibling will return null Node sectionBeforeLast = lastSection.getPreviousSibling(); if (sectionBeforeLast != null) { doc.removeChild(sectionBeforeLast); }
removeSmartTags | → inherited from CompositeNode |
public void removeSmartTags() |
Example:
Removes all smart tags from descendant nodes of the composite node.Document doc = new Document(getMyDir() + "Document.docx"); // Remove smart tags from the first paragraph in the document doc.getFirstSection().getBody().getFirstParagraph().removeSmartTags();
selectNodes | → inherited from CompositeNode |
public NodeList selectNodes(java.lang.String xpath) |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.Example:
Shows how to select certain nodes by using an XPath expression.Document doc = new Document(getMyDir() + "Tables.docx"); // This expression will extract all paragraph nodes which are descendants of any table node in the document // This will return any paragraphs which are in a table NodeList nodeList = doc.selectNodes("//Table//Paragraph"); // Iterate through the list with an enumerator and print the contents of every paragraph in each cell of the table int index = 0; Iterator<Node> e = nodeList.iterator(); while (e.hasNext()) { Node currentNode = e.next(); System.out.println(MessageFormat.format("Table paragraph index {0}, contents: \"{1}\"", index++, currentNode.getText().trim())); } // This expression will select any paragraphs that are direct children of any body node in the document nodeList = doc.selectNodes("//Body/Paragraph"); // We can treat the list as an array too Assert.assertEquals(nodeList.toArray().length, 4); // Use SelectSingleNode to select the first result of the same expression as above Node node = doc.selectSingleNode("//Body/Paragraph");
Example:
Shows how to test if a node is inside a field by using an XPath expression.// Let's pick a document we know has some fields in Document doc = new Document(getMyDir() + "Mail merge destination - Northwind employees.docx"); // Let's say we want to check if the Run below is inside a field Run run = (Run) doc.getChild(NodeType.RUN, 5, true); // Evaluate the XPath expression. The resulting NodeList will contain all nodes found inside a field a field (between FieldStart // and FieldEnd exclusive). There can however be FieldStart and FieldEnd nodes in the list if there are nested fields // in the path. Currently does not find rare fields in which the FieldCode or FieldResult spans across multiple paragraphs NodeList resultList = doc.selectNodes("//FieldStart/following-sibling::node()[following-sibling::FieldEnd]"); // Check if the specified run is one of the nodes that are inside the field for (Node node : (Iterable<Node>) resultList) { if (node == run) { System.out.println("The node is found inside a field"); break; } }
selectSingleNode | → inherited from CompositeNode |
public Node selectSingleNode(java.lang.String xpath) |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.Example:
Shows how to select certain nodes by using an XPath expression.Document doc = new Document(getMyDir() + "Tables.docx"); // This expression will extract all paragraph nodes which are descendants of any table node in the document // This will return any paragraphs which are in a table NodeList nodeList = doc.selectNodes("//Table//Paragraph"); // Iterate through the list with an enumerator and print the contents of every paragraph in each cell of the table int index = 0; Iterator<Node> e = nodeList.iterator(); while (e.hasNext()) { Node currentNode = e.next(); System.out.println(MessageFormat.format("Table paragraph index {0}, contents: \"{1}\"", index++, currentNode.getText().trim())); } // This expression will select any paragraphs that are direct children of any body node in the document nodeList = doc.selectNodes("//Body/Paragraph"); // We can treat the list as an array too Assert.assertEquals(nodeList.toArray().length, 4); // Use SelectSingleNode to select the first result of the same expression as above Node node = doc.selectSingleNode("//Body/Paragraph");
setBorder | |
public void setBorder(int borderType, int lineStyle, double lineWidth, java.awt.Color color, boolean isOverrideCellBorders) throws java.lang.Exception |
borderType
- A lineStyle
- A lineWidth
- The line width to set (in points).color
- The color to use for the border.isOverrideCellBorders
- When true
, causes all existing explicit cell borders to be removed.Example:
Shows how to apply a outline border to a table.Document doc = new Document(getMyDir() + "Tables.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); // Align the table to the center of the page table.setAlignment(TableAlignment.CENTER); // Clear any existing borders and shading from the table table.clearBorders(); table.clearShading(); // Set a green border around the table but not inside table.setBorder(BorderType.LEFT, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.RIGHT, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.TOP, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.BOTTOM, LineStyle.SINGLE, 1.5, Color.GREEN, true); // Fill the cells with a light green solid color table.setShading(TextureIndex.TEXTURE_SOLID, Color.GREEN, Color.GREEN); doc.save(getArtifactsDir() + "Table.SetOutlineBorders.docx");
setBorders | |
public void setBorders(int lineStyle, double lineWidth, java.awt.Color color) throws java.lang.Exception |
lineStyle
- A lineWidth
- The line width to set (in points).color
- The color to use for the border.Example:
Shows how to format table and cell with different borders and shadings.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); builder.insertCell(); // Set the borders for the entire table table.setBorders(LineStyle.SINGLE, 2.0, Color.BLACK); // Set the cell shading for this cell builder.getCellFormat().getShading().setBackgroundPatternColor(Color.RED); builder.writeln("Cell #1"); builder.insertCell(); // Specify a different cell shading for the second cell builder.getCellFormat().getShading().setBackgroundPatternColor(Color.GREEN); builder.writeln("Cell #2"); // End this row builder.endRow(); // Clear the cell formatting from previous operations builder.getCellFormat().clearFormatting(); // Create the second row builder.insertCell(); // Create larger borders for the first cell of this row. This will be different // compared to the borders set for the table builder.getCellFormat().getBorders().getLeft().setLineWidth(4.0); builder.getCellFormat().getBorders().getRight().setLineWidth(4.0); builder.getCellFormat().getBorders().getTop().setLineWidth(4.0); builder.getCellFormat().getBorders().getBottom().setLineWidth(4.0); builder.writeln("Cell #3"); builder.insertCell(); // Clear the cell formatting from the previous cell builder.getCellFormat().clearFormatting(); builder.writeln("Cell #4"); doc.save(getArtifactsDir() + "DocumentBuilder.TableBordersAndShading.doc");
Example:
Shows how to build a table with all borders enabled (grid).Document doc = new Document(getMyDir() + "Tables.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); // Clear any existing borders from the table table.clearBorders(); // Set a green border around and inside the table table.setBorders(LineStyle.SINGLE, 1.5, Color.GREEN); doc.save(getArtifactsDir() + "Table.SetAllBorders.doc");
setShading | |
public void setShading(int texture, java.awt.Color foregroundColor, java.awt.Color backgroundColor) |
texture
- A foregroundColor
- The color of the texture.backgroundColor
- The color of the background fill.Example:
Shows how to apply a outline border to a table.Document doc = new Document(getMyDir() + "Tables.docx"); Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); // Align the table to the center of the page table.setAlignment(TableAlignment.CENTER); // Clear any existing borders and shading from the table table.clearBorders(); table.clearShading(); // Set a green border around the table but not inside table.setBorder(BorderType.LEFT, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.RIGHT, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.TOP, LineStyle.SINGLE, 1.5, Color.GREEN, true); table.setBorder(BorderType.BOTTOM, LineStyle.SINGLE, 1.5, Color.GREEN, true); // Fill the cells with a light green solid color table.setShading(TextureIndex.TEXTURE_SOLID, Color.GREEN, Color.GREEN); doc.save(getArtifactsDir() + "Table.SetOutlineBorders.docx");
toString | → inherited from Node |
public java.lang.String toString(SaveOptions saveOptions) throws java.lang.Exception |
saveOptions
- Specifies the options that control how the node is saved.Example:
Exports the content of a node to String in HTML format using custom specified options.Document doc = new Document(getMyDir() + "Document.docx"); // Extract the last paragraph in the document to convert to HTML Node node = doc.getLastSection().getBody().getLastParagraph(); // Create an instance of HtmlSaveOptions and set a few options HtmlSaveOptions saveOptions = new HtmlSaveOptions(); saveOptions.setExportHeadersFootersMode(ExportHeadersFootersMode.PER_SECTION); saveOptions.setExportRelativeFontSize(true); // Convert the document to HTML and return as a String. Pass the instance of HtmlSaveOptions to // to use the specified options during the conversion String nodeAsHtml = node.toString(saveOptions);
toString | → inherited from Node |
public java.lang.String toString(int saveFormat) throws java.lang.Exception |
saveFormat
- A SaveFormat value.Example:
Shows how to extract the label of each paragraph in a list as a value or a String.Document doc = new Document(getMyDir() + "Rendering.docx"); doc.updateListLabels(); int listParaCount = 1; for (Paragraph paragraph : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) { // Find if we have the paragraph list. In our document our list uses plain arabic numbers, // which start at three and ends at six if (paragraph.getListFormat().isListItem()) { System.out.println(MessageFormat.format("Paragraph #{0}", listParaCount)); // This is the text we get when actually getting when we output this node to text format // The list labels are not included in this text output. Trim any paragraph formatting characters String paragraphText = paragraph.toString(SaveFormat.TEXT).trim(); System.out.println("Exported Text: " + paragraphText); ListLabel label = paragraph.getListLabel(); // This gets the position of the paragraph in current level of the list. If we have a list with multiple level then this // will tell us what position it is on that particular level System.out.println("Numerical Id: " + label.getLabelValue()); // Combine them together to include the list label with the text in the output System.out.println("List label combined with text: " + label.getLabelString() + " " + paragraphText); listParaCount++; } }
Example:
Exports the content of a node to String in HTML format using default options.Document doc = new Document(getMyDir() + "Document.docx"); // Extract the last paragraph in the document to convert to HTML Node node = doc.getLastSection().getBody().getLastParagraph(); // When ToString is called using the SaveFormat overload then conversion is executed using default save options // When saving to HTML using default options the following settings are set: // ExportImagesAsBase64 = true // CssStyleSheetType = CssStyleSheetType.Inline // ExportFontResources = false String nodeAsHtml = node.toString(SaveFormat.HTML);
Example:
Shows the difference between calling the GetText and ToString methods on a node.Document doc = new Document(); // Enter a field into the document DocumentBuilder builder = new DocumentBuilder(doc); builder.insertField("MERGEFIELD Field"); // GetText will retrieve all field codes and special characters Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText()); // ToString will give us the plaintext version of the document in the save format we put into the parameter Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));