com.aspose.words
Class Table

com.aspose.words.CompositeNode
    extended by com.aspose.words.Table

public class Table 
extends com.aspose.words.CompositeNode

Represents a table in a Word document.

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.


Property Getters/Setters Summary
intgetAlignment()
voidsetAlignment(int value)
           Specifies how an inline table is aligned in the document. The value of the property is TableAlignment integer constant.
booleangetAllowAutoFit()
voidsetAllowAutoFit(boolean value)
           Allows Microsoft Word and Aspose.Words to automatically resize cells in a table to fit their contents.
booleangetBidi()
voidsetBidi(boolean value)
           Gets or sets whether this is a right-to-left table.
doublegetBottomPadding()
voidsetBottomPadding(double value)
           Gets or sets the amount of space (in points) to add below the contents of cells.
doublegetCellSpacing()
voidsetCellSpacing(double value)
           Gets or sets the amount of space (in points) between the cells.
Aspose.Words.NodeCollectiongetChildNodes()→ inherited from Aspose.Words.CompositeNode
           Gets all immediate child nodes of this node.
intgetCount()→ inherited from Aspose.Words.CompositeNode
           Gets the number of immediate children of this node.
doublegetDistanceBottom()
          
doublegetDistanceLeft()
          
doublegetDistanceRight()
          
doublegetDistanceTop()
          
Aspose.Words.DocumentBasegetDocument()→ inherited from Aspose.Words.Node
           Gets the document to which this node belongs.
Aspose.Words.NodegetFirstChild()→ inherited from Aspose.Words.CompositeNode
           Gets the first child of the node.
RowgetFirstRow()
           Returns the first Row node in the table.
booleanhasChildNodes()→ inherited from Aspose.Words.CompositeNode
           Returns true if this node has any child nodes.
booleanisComposite()→ inherited from Aspose.Words.CompositeNode
           Returns true as this node can have child nodes.
Aspose.Words.NodegetLastChild()→ inherited from Aspose.Words.CompositeNode
           Gets the last child of the node.
RowgetLastRow()
           Returns the last Row node in the table.
doublegetLeftIndent()
voidsetLeftIndent(double value)
           Gets or sets the value that represents the left indent of the table.
doublegetLeftPadding()
voidsetLeftPadding(double value)
           Gets or sets the amount of space (in points) to add to the left of the contents of cells.
Aspose.Words.NodegetNextSibling()→ inherited from Aspose.Words.Node
           Gets the node immediately following this node.
Aspose.Words.NodeTypegetNodeType()
           Returns NodeType.Table.
Aspose.Words.CompositeNodegetParentNode()→ inherited from Aspose.Words.Node
           Gets the immediate parent of this node.
PreferredWidthgetPreferredWidth()
voidsetPreferredWidth(PreferredWidth value)
           Gets or sets the table preferred width.
Aspose.Words.NodegetPreviousSibling()→ inherited from Aspose.Words.Node
           Gets the node immediately preceding this node.
Aspose.Words.RangegetRange()→ inherited from Aspose.Words.Node
           Returns a Range object that represents the portion of a document that is contained in this node.
doublegetRightPadding()
voidsetRightPadding(double value)
           Gets or sets the amount of space (in points) to add to the right of the contents of cells.
RowCollectiongetRows()
           Provides typed access to the rows of the table.
Aspose.Words.StylegetStyle()
           Gets or sets the table style applied to this table.
Aspose.Words.StyleIdentifiergetStyleIdentifier()
           Gets or sets the locale independent style identifier of the table style applied to this table.
java.lang.StringgetStyleName()
voidsetStyleName(java.lang.String value)
           Gets or sets the name of the table style applied to this table.
intgetStyleOptions()
voidsetStyleOptions(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.
intgetTextWrapping()
voidsetTextWrapping(int value)
           Get or sets TextWrapping TextWrapping for table. The value of the property is TextWrapping integer constant.
doublegetTopPadding()
voidsetTopPadding(double value)
           Gets or sets the amount of space (in points) to add above the contents of cells.
 
Method Summary
voidautoFit(int behavior)
           Resizes the table and cells according to the specified auto fit behavior.
voidclearBorders()
           Removes all table and cell borders on this table.
voidclearShading()
           Removes all shading on the table.
Aspose.Words.NodedeepClone(boolean isCloneChildren)→ inherited from Aspose.Words.Node
           Creates a duplicate of the node.
voidensureMinimum()
           If the table has no rows, creates and appends one Row.
Aspose.Words.CompositeNodegetAncestor(java.lang.Class ancestorType)→ inherited from Aspose.Words.Node
           Gets the first ancestor of the specified object type.
Aspose.Words.CompositeNodegetContainer()→ inherited from Aspose.Words.CompositeNode
          Reserved for internal use.
Aspose.Words.NodegetNextMatchingNode(aspose.obfuscated.type curNode)→ inherited from Aspose.Words.CompositeNode
          Reserved for internal use.
java.lang.StringgetText()→ inherited from Aspose.Words.CompositeNode
           Gets the text of this node and of all its children.
java.util.Iteratoriterator()→ inherited from Aspose.Words.CompositeNode
           Provides support for the for each style iteration over the child nodes of this node.
voidremove()→ inherited from Aspose.Words.Node
           Removes itself from the parent.
voidremoveAllChildren()→ inherited from Aspose.Words.CompositeNode
           Removes all the child nodes of the current node.
voidremoveSmartTags()→ inherited from Aspose.Words.CompositeNode
           Removes all SmartTag descendant nodes of the current node.
Aspose.Words.NodeListselectNodes(java.lang.String xpath)→ inherited from Aspose.Words.CompositeNode
           Selects a list of nodes matching the XPath expression.
Aspose.Words.NodeselectSingleNode(java.lang.String xpath)→ inherited from Aspose.Words.CompositeNode
           Selects the first Node that matches the XPath expression.
java.lang.StringtoString(SaveOptions saveOptions)→ inherited from Aspose.Words.Node
           Exports the content of the node into a string using the specified save options.
java.lang.StringtoTxt()→ inherited from Aspose.Words.Node
           Exports the content of the node into a string in plain text format.
 

Property Getters/Setters Detail

getAlignment/setAlignment

public int getAlignment() / public void setAlignment(int value)
Specifies how an inline table is aligned in the document. The value of the property is TableAlignment integer constant.

The default value is TableAlignment.LEFT.


getAllowAutoFit/setAllowAutoFit

public boolean getAllowAutoFit() / public void setAllowAutoFit(boolean value)
Allows Microsoft Word and Aspose.Words to automatically resize cells in a table to fit their contents.

The default value is true.

See Also:
autoFit(int)

getBidi/setBidi

public boolean getBidi() / public void setBidi(boolean value)
Gets or sets whether this is a right-to-left table.

When true, the cells in this row are laid out right to left.

The default value is false.


getBottomPadding/setBottomPadding

public double getBottomPadding() / public void setBottomPadding(double value)
Gets or sets the amount of space (in points) to add below the contents of cells.

getCellSpacing/setCellSpacing

public double getCellSpacing() / public void setCellSpacing(double value)
Gets or sets the amount of space (in points) between the cells.

getChildNodes

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.NodeCollection getChildNodes()
Gets all immediate child nodes of this node.

Note, #Error Cref: P:Aspose.Words.CompositeNode.ChildNodes is equivalent to calling 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.


getCount

→ inherited from Aspose.Words.CompositeNode
public int getCount()
Gets the number of immediate children of this node.

getDistanceBottom

public double getDistanceBottom()

getDistanceLeft

public double getDistanceLeft()

getDistanceRight

public double getDistanceRight()

getDistanceTop

public double getDistanceTop()

getDocument

→ inherited from Aspose.Words.Node
public Aspose.Words.DocumentBase getDocument()
Gets the document to which this node belongs.

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.


getFirstChild

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.Node getFirstChild()
Gets the first child of the node. If there is no first child node, a null is returned.

getFirstRow

public Row getFirstRow()
Returns the first Row node in the table.

hasChildNodes

→ inherited from Aspose.Words.CompositeNode
public boolean hasChildNodes()
Returns true if this node has any child nodes.

isComposite

→ inherited from Aspose.Words.CompositeNode
public boolean isComposite()
Returns true as this node can have child nodes.

getLastChild

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.Node getLastChild()
Gets the last child of the node. If there is no last child node, a null is returned.

getLastRow

public Row getLastRow()
Returns the last Row node in the table.

getLeftIndent/setLeftIndent

public double getLeftIndent() / public void setLeftIndent(double value)
Gets or sets the value that represents the left indent of the table.

getLeftPadding/setLeftPadding

public double getLeftPadding() / public void setLeftPadding(double value)
Gets or sets the amount of space (in points) to add to the left of the contents of cells.

getNextSibling

→ inherited from Aspose.Words.Node
public Aspose.Words.Node getNextSibling()
Gets the node immediately following this node. If there is no next node, a null is returned.

getNodeType

public Aspose.Words.NodeType getNodeType()
Returns NodeType.Table.

getParentNode

→ inherited from Aspose.Words.Node
public Aspose.Words.CompositeNode getParentNode()
Gets the immediate parent of this node.

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.


getPreferredWidth/setPreferredWidth

public PreferredWidth getPreferredWidth() / public void setPreferredWidth(PreferredWidth value)
Gets or sets the table preferred width.

The default value is PreferredWidth.AUTO.


getPreviousSibling

→ inherited from Aspose.Words.Node
public Aspose.Words.Node getPreviousSibling()
Gets the node immediately preceding this node. If there is no preceding node, a null is returned.

getRange

→ inherited from Aspose.Words.Node
public Aspose.Words.Range getRange()
Returns a Range object that represents the portion of a document that is contained in this node.

getRightPadding/setRightPadding

public double getRightPadding() / public void setRightPadding(double value)
Gets or sets the amount of space (in points) to add to the right of the contents of cells.

getRows

public RowCollection getRows()
Provides typed access to the rows of the table.

getStyle

public Aspose.Words.Style getStyle()
Gets or sets the table style applied to this table.

getStyleIdentifier

public Aspose.Words.StyleIdentifier getStyleIdentifier()
Gets or sets the locale independent style identifier of the table style applied to this table.

getStyleName/setStyleName

public java.lang.String getStyleName() / public void setStyleName(java.lang.String value)
Gets or sets the name of the table style applied to this table.

getStyleOptions/setStyleOptions

public int getStyleOptions() / public 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.

getTextWrapping/setTextWrapping

public int getTextWrapping() / public void setTextWrapping(int value)
Get or sets TextWrapping TextWrapping for table. The value of the property is TextWrapping integer constant.

getTopPadding/setTopPadding

public double getTopPadding() / public void setTopPadding(double value)
Gets or sets the amount of space (in points) to add above the contents of cells.

Method Detail

autoFit

public void autoFit(int behavior)
            throws java.lang.Exception
Resizes the table and cells according to the specified auto fit behavior.

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.

Parameters:
behavior - A AutoFitBehavior value. Specifies how to auto fit the table.

clearBorders

public void clearBorders()
Removes all table and cell borders on this table.

clearShading

public void clearShading()
Removes all shading on the table.

deepClone

→ inherited from Aspose.Words.Node
public Aspose.Words.Node deepClone(boolean isCloneChildren)
Creates a duplicate of the node.

This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.

This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.

Parameters:
isCloneChildren - True to recursively clone the subtree under the specified node; false to clone only the node itself.
Returns:
The cloned node.

ensureMinimum

public void ensureMinimum()
If the table has no rows, creates and appends one Row.

getAncestor

→ inherited from Aspose.Words.Node
public Aspose.Words.CompositeNode getAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified object type.

The ancestor type matches if it is equal to ancestorType or derived from ancestorType.

Parameters:
ancestorType - The object type of the ancestor to retrieve.
Returns:
The ancestor of the specified type or null if no ancestor of this type was found.

getContainer

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.CompositeNode getContainer()
Reserved for internal use.

getNextMatchingNode

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.Node getNextMatchingNode(aspose.obfuscated.type curNode)
Reserved for internal use.

getText

→ inherited from Aspose.Words.CompositeNode
public java.lang.String getText()
Gets the text of this node and of all its children.

The returned string includes all control and special characters as described in Aspose.Words.ControlChar.


iterator

→ inherited from Aspose.Words.CompositeNode
public java.util.Iterator iterator()
Provides support for the for each style iteration over the child nodes of this node.

remove

→ inherited from Aspose.Words.Node
public void remove()
Removes itself from the parent.

removeAllChildren

→ inherited from Aspose.Words.CompositeNode
public void removeAllChildren()
Removes all the child nodes of the current node.

removeSmartTags

→ inherited from Aspose.Words.CompositeNode
public void removeSmartTags()
Removes all SmartTag descendant nodes of the current node. This method does not remove the content of the smart tags.

selectNodes

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.NodeList selectNodes(java.lang.String xpath)
Selects a list of nodes matching the XPath expression.

Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

Parameters:
xpath - The XPath expression.
Returns:
A list of nodes matching the XPath query.

selectSingleNode

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.Node selectSingleNode(java.lang.String xpath)
Selects the first Node that matches the XPath expression.

Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

Parameters:
xpath - The XPath expression.
Returns:
The first Node that matches the XPath query or null if no matching node is found.

toString

→ inherited from Aspose.Words.Node
public java.lang.String toString(SaveOptions saveOptions)
               throws java.lang.Exception
Exports the content of the node into a string using the specified save options.
Parameters:
saveOptions - Specifies the options that control how the node is saved.
Returns:
The content of the node in the specified format.

toTxt

→ inherited from Aspose.Words.Node
public java.lang.String toTxt()
            throws java.lang.Exception
Exports the content of the node into a string in plain text format.

This method removes field codes and Microsoft Word control characters, uses CrLf (or any other) combination of characters to mark ends of paragraphs in the resulting string. It produces a different result from #Error Cref: M:Aspose.Words.Node.GetText which just gets the text from the node without removing field codes or special characters.

Returns:
The content of the node in plain text format.
See Also:
TxtSaveOptions.ParagraphBreak, TxtSaveOptions.ExportHeadersFooters

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.