com.spire.presentation
Interface ITable

All Superinterfaces:

IShape

public interface ITable
extends IShape

Method Summary

void	dispose() Dispose object and free resources.
Cell	get(int columnIndex, int rowIndex) Gets the cell at the specified column and row indexes.
java.lang.String	getAlternativeText() Gets the alternative text associated with a shape.
ClickHyperlink	getClick() Gets the hyperlink defined for mouse click.
ColumnCollection	getColumnsList() Gets the collectoin of columns.
EffectDag	getEffectDag() Gets the EffectFormat object which contains pixel effects applied to a shape.
FillFormat	getFill() Gets the FillFormat object that contains fill formatting properties for a shape.
boolean	getFirstCol() Indicates whether the first column of a table has to be drawn with a special formatting.
boolean	getFirstRow() Indicates whether the first row of a table has to be drawn with a special formatting.
GraphicFrame	getFrame() Gets the shape frame's properties.
float	getHeight() Gets the height of the shape.
boolean	getHorizontalBanding() Indicates whether the even rows has to be drawn with a different formatting.
boolean	getLastCol() Indicates whether the last column of a table has to be drawn with a special formatting.
boolean	getLastRow() Indicates whether the last row of a table has to be drawn with a special formatting.
float	getLeft() Gets the x-coordinate of the upper-left corner of the shape.
TextLineFormat	getLine() Gets the LineFormat object that contains line formatting properties for a shape.
ClickHyperlink	getMouseOver() Gets the hyperlink defined for mouse over.
java.lang.String	getName() Gets the name of a shape.
ActiveSlide	getParent() Gets the parent slide of a shape.
PlaceholderEx	getPlaceholder() Gets the placeholder for a shape.
Presentation	getPresentation()
boolean	getRightToLeft() Indicates whether the table has right to left reading order.
float	getRotation() Gets the number of degrees the specified shape is rotated around the z-axis.
GraphicalNodeLocking	getShapeLocking() Gets lock type of shape.
ActiveSlide	getSlide() Gets the parent slide of a shape.
TableStylePreset	getStylePreset() Get's builtin table style.
TableRowCollection	getTableRows() Gets the collectoin of rows.
TagCollection	getTagsList() Gets the shape's tags collection.
FormatThreeD	getThreeD() Gets the ThreeDFormat object that 3d effect properties for a shape.
float	getTop() Gets the y-coordinate of the upper-left corner of the shape.
boolean	getVerticalBanding() Indicates whether the even columns has to be drawn with a different formatting.
float	getWidth() Gets the width of the shape.
int	getZOrderPosition() Gets the position of a shape in the z-order.
boolean	isHidden() Indicates whether the shape is hidden.
void	isHidden(boolean value)
boolean	isTextBox() Indicates whether the shape is TextHolder.
void	mergeCells(Cell cell1, Cell cell2, boolean allowSplitting) Merges neighbour cells.
void	removePlaceholder() Removes placeholder from the shape.s
void	setAlternativeText(java.lang.String value) Sets the alternative text associated with a shape.
void	setClick(ClickHyperlink value) Sets the hyperlink defined for mouse click.
void	setFirstRow(boolean value)
void	setFrame(GraphicFrame value) Sets the shape frame's properties.
void	setHeight(float value) sets the height of the shape.
void	setHorizontalBanding(boolean value)
void	setLastCol(boolean value)
void	setLastRow(boolean value)
void	setLeft(double value) Sets the x-coordinate of the upper-left corner of the shape.
void	setMouseOver(ClickHyperlink value) Sets the hyperlink defined for mouse over.
void	setName(java.lang.String value) Sets the name of a shape.
void	setRightToLeft(boolean value)
void	setRotation(float value) Sets the number of degrees the specified shape is rotated around the z-axis.
void	setStylePreset(TableStylePreset value) Sets builtin table style.
void	setTableBorder(TableBorderType borderType, double borderWidth, java.awt.Color borderColor) Setting up the table border
void	setTop(double value) Sets the y-coordinate of the upper-left corner of the shape.
void	setVerticalBanding(boolean value)
void	setWidth(float value) sets the width of the shape.

Methods inherited from interface com.spire.presentation.IShape

getAlternativeTitle, insertChart, insertPicture, insertSmartArt, insertTable, insertVideo, setAlternativeTitle, setShapeAlignment, setShapeArrange

Method Detail

mergeCells

void mergeCells(Cell cell1,
                Cell cell2,
                boolean allowSplitting)
                throws DocumentEditException

Merges neighbour cells.

Parameters:

cell1 - Cell to merge.

cell2 - Cell to merge.

allowSplitting - True to allow cells splitting.

Throws:

DocumentEditException

setTableBorder

void setTableBorder(TableBorderType borderType,
                    double borderWidth,
                    java.awt.Color borderColor)

Setting up the table border

Parameters:

borderType - border type

borderWidth - border width.

borderColor - border java.awt.Color.

getStylePreset

TableStylePreset getStylePreset()

Get's builtin table style. Read/write .

Returns:

setStylePreset

void setStylePreset(TableStylePreset value)

Sets builtin table style. Read/write .

getTableRows

TableRowCollection getTableRows()

Gets the collectoin of rows. Read-only .

Returns:

getColumnsList

ColumnCollection getColumnsList()

Gets the collectoin of columns. Read-only .

Returns:

getRightToLeft

boolean getRightToLeft()

Indicates whether the table has right to left reading order. Read-write .

Returns:

setRightToLeft

void setRightToLeft(boolean value)

getFirstRow

boolean getFirstRow()

Indicates whether the first row of a table has to be drawn with a special formatting. Read/write .

Returns:

setFirstRow

void setFirstRow(boolean value)

getFirstCol

boolean getFirstCol()

Indicates whether the first column of a table has to be drawn with a special formatting. Read/write .

Returns:

getLastRow

boolean getLastRow()

Indicates whether the last row of a table has to be drawn with a special formatting. Read/write .

Returns:

setLastRow

void setLastRow(boolean value)

getLastCol

boolean getLastCol()

Indicates whether the last column of a table has to be drawn with a special formatting. Read/write .

Returns:

setLastCol

void setLastCol(boolean value)

getHorizontalBanding

boolean getHorizontalBanding()

Indicates whether the even rows has to be drawn with a different formatting. Read/write .

Returns:

setHorizontalBanding

void setHorizontalBanding(boolean value)

getVerticalBanding

boolean getVerticalBanding()

Indicates whether the even columns has to be drawn with a different formatting. Read/write .

Returns:

setVerticalBanding

void setVerticalBanding(boolean value)

getShapeLocking

GraphicalNodeLocking getShapeLocking()

Gets lock type of shape. Read-only .

Returns:

isTextBox

boolean isTextBox()

Indicates whether the shape is TextHolder. Read-only .

Specified by:

isTextBox in interface IShape

Returns:

getPlaceholder

PlaceholderEx getPlaceholder()

Gets the placeholder for a shape. Read-only .

Specified by:

getPlaceholder in interface IShape

Returns:

getTagsList

TagCollection getTagsList()

Gets the shape's tags collection. Read-only .

Specified by:

getTagsList in interface IShape

Returns:

getFrame

GraphicFrame getFrame()

Gets the shape frame's properties. Read/write .

Specified by:

getFrame in interface IShape

Returns:

setFrame

void setFrame(GraphicFrame value)

Sets the shape frame's properties. Read/write .

Specified by:

setFrame in interface IShape

getLine

TextLineFormat getLine()

Gets the LineFormat object that contains line formatting properties for a shape. Read-only .

Specified by:

getLine in interface IShape

Returns:

can return null for certain types of shapes which don't have line properties.

getThreeD

FormatThreeD getThreeD()

Gets the ThreeDFormat object that 3d effect properties for a shape. Read-only .

Specified by:

getThreeD in interface IShape

Returns:

can return null for certain types of shapes which don't have 3d properties.

getEffectDag

EffectDag getEffectDag()

Gets the EffectFormat object which contains pixel effects applied to a shape. Read-only

Specified by:

getEffectDag in interface IShape

Returns:

can return null for certain types of shapes which don't have effect properties.

getFill

FillFormat getFill()

Gets the FillFormat object that contains fill formatting properties for a shape. Read-only .

Specified by:

getFill in interface IShape

Returns:

can return null for certain types of shapes which don't have fill properties.

getClick

ClickHyperlink getClick()

Gets the hyperlink defined for mouse click. Read/write .

Specified by:

getClick in interface IShape

Returns:

setClick

void setClick(ClickHyperlink value)

Sets the hyperlink defined for mouse click. Read/write .

Specified by:

setClick in interface IShape

getMouseOver

ClickHyperlink getMouseOver()

Gets the hyperlink defined for mouse over. Read/write .

Specified by:

getMouseOver in interface IShape

Returns:

setMouseOver

void setMouseOver(ClickHyperlink value)

Sets the hyperlink defined for mouse over. Read/write .

Specified by:

setMouseOver in interface IShape

isHidden

boolean isHidden()

Indicates whether the shape is hidden. Read/write .

Specified by:

isHidden in interface IShape

Returns:

isHidden

void isHidden(boolean value)

Specified by:

isHidden in interface IShape

getParent

ActiveSlide getParent()

Gets the parent slide of a shape. Read-only .

Specified by:

getParent in interface IShape

Returns:

getZOrderPosition

int getZOrderPosition()

Gets the position of a shape in the z-order. Read-only .

Specified by:

getZOrderPosition in interface IShape

Returns:

Shapes[0] returns the shape at the back of the z-order, and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order.

getRotation

float getRotation()

Gets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write .

Specified by:

getRotation in interface IShape

Returns:

setRotation

void setRotation(float value)

Sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write .

Specified by:

setRotation in interface IShape

getLeft

float getLeft()

Gets the x-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

getLeft in interface IShape

Returns:

setLeft

void setLeft(double value)

Sets the x-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

setLeft in interface IShape

getTop

float getTop()

Gets the y-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

getTop in interface IShape

Returns:

setTop

void setTop(double value)

Sets the y-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

setTop in interface IShape

getWidth

float getWidth()

Gets the width of the shape. Read/write .

Specified by:

getWidth in interface IShape

Returns:

setWidth

void setWidth(float value)

sets the width of the shape. Read/write .

Specified by:

setWidth in interface IShape

getHeight

float getHeight()

Gets the height of the shape. Read/write .

Specified by:

getHeight in interface IShape

Returns:

setHeight

void setHeight(float value)

sets the height of the shape. Read/write .

Specified by:

setHeight in interface IShape

getAlternativeText

java.lang.String getAlternativeText()

Gets the alternative text associated with a shape. Read/write .

Specified by:

getAlternativeText in interface IShape

Returns:

setAlternativeText

void setAlternativeText(java.lang.String value)

Sets the alternative text associated with a shape. Read/write .

Specified by:

setAlternativeText in interface IShape

getName

java.lang.String getName()

Gets the name of a shape. Read/write .

Specified by:

getName in interface IShape

Returns:

setName

void setName(java.lang.String value)

Sets the name of a shape. Read/write .

Specified by:

setName in interface IShape

getSlide

ActiveSlide getSlide()

Gets the parent slide of a shape. Read-only .

Specified by:

getSlide in interface IShape

Returns:

getPresentation

Presentation getPresentation()

Specified by:

getPresentation in interface IShape

get

Cell get(int columnIndex,
         int rowIndex)

Gets the cell at the specified column and row indexes. Read-only .

Parameters:

columnIndex -

rowIndex -

Returns:

removePlaceholder

void removePlaceholder()

Removes placeholder from the shape.s

Specified by:

removePlaceholder in interface IShape

dispose

void dispose()

Dispose object and free resources.

Specified by:

dispose in interface IShape