Table

Table class

Represents a table on a slide.

addPlaceholder

Name	Description
addPlaceholder(Placeholder)	Adds a new placeholder if there is no and sets placeholder properties to a specified one.

Parameters:

Name	Type	Description
placeholderToCopyFrom	Placeholder	Placeholder to copy content from.

Result: Placeholder

---

getAlternativeText

Name	Description
getAlternativeText()	Returns or sets the alternative text associated with a shape. Read/write String.

Result: String

---

getAlternativeTextTitle

Name	Description
getAlternativeTextTitle()	Returns or sets the title of alternative text associated with a shape. Read/write String.

Result: String

---

getBasePlaceholder

Name	Description
getBasePlaceholder()	Returns a basic placeholder shape (shape from the layout and/or master slide that the current shape is inherited from). A null is returned if the current shape is not inherited.

Result: SummaryZoomSection, AutoShape, AudioFrame, OleObjectFrame, SummaryZoomFrame, ZoomFrame, GraphicalObject, PictureFrame, ZoomObject, VideoFrame, GeometryShape, SmartArtShape, SmartArt, Ink, Chart, GroupShape, Table, SectionZoomFrame, Shape, LegacyDiagram, Connector

---

getBlackWhiteMode

Name	Description
getBlackWhiteMode()	Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode.

Result: byte

---

getColumns

Name	Description
getColumns()	Returns the collectoin of columns. Read-only IColumnCollection.

Result: ColumnCollection

---

getConnectionSiteCount

Name	Description
getConnectionSiteCount()	Returns the number of connection sites on the shape. Read-only int.

Result: int

---

getCustomData

Name	Description
getCustomData()	Returns the shape’s custom data. Read-only ICustomData.

Result: CustomData

---

getEffectFormat

Name	Description
getEffectFormat()	Returns the EffectFormat object which contains pixel effects applied to a shape. Note: can return null for certain types of shapes which don’t have effect properties. Read-only IEffectFormat.

Result: EffectFormat

---

getFillFormat

Name	Description
getFillFormat()	Returns the FillFormat object that contains fill formatting properties for a shape. Note: can return null for certain types of shapes which don’t have fill properties. Read-only IFillFormat.

Result: FillFormat

---

getFillFormat

Name	Description
getFillFormat()	Returns the FillFormat object that contains fill formatting properties for a shape. Note: can return null for certain types of shapes which don’t have fill properties. Read-only IFillFormat.

Result: FillFormat

---

getFirstCol

Name	Description
getFirstCol()	Determines whether the first column of a table has to be drawn with a special formatting. Read/write boolean.

Result: boolean

---

getFirstRow

Name	Description
getFirstRow()	Determines whether the first row of a table has to be drawn with a special formatting. Read/write boolean.

Result: boolean

---

getFrame

Name	Description
getFrame()	Returns or sets the shape frame’s properties. Read/write IShapeFrame. Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties.

Result: ShapeFrame

---

getGraphicalObjectLock

Name	Description
getGraphicalObjectLock()	Returns shape’s locks. Read-only IGraphicalObjectLock.

Result: GraphicalObjectLock

---

getHeight

Name	Description
getHeight()	Returns or sets the height of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float

---

getHidden

Name	Description
getHidden()	Determines whether the shape is hidden. Read/write boolean.

Result: boolean

---

getHorizontalBanding

Name	Description
getHorizontalBanding()	Determines whether the even rows has to be drawn with a different formatting. Read/write boolean.

Result: boolean

---

getHyperlinkClick

Name	Description
getHyperlinkClick()	Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink.

Result: Hyperlink

---

getHyperlinkManager

Name	Description
getHyperlinkManager()	Returns the hyperlink manager. Read-only IHyperlinkManager.

Result: HyperlinkManager

---

getHyperlinkMouseOver

Name	Description
getHyperlinkMouseOver()	Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink.

Result: Hyperlink

---

getLastCol

Name	Description
getLastCol()	Determines whether the last column of a table has to be drawn with a special formatting. Read/write boolean.

Result: boolean

---

getLastRow

Name	Description
getLastRow()	Determines whether the last row of a table has to be drawn with a special formatting. Read/write boolean.

Result: boolean

---

getLineFormat

Name	Description
getLineFormat()	Returns the LineFormat object that contains line formatting properties for a shape. Note: can return null for certain types of shapes which don’t have line properties. Read-only ILineFormat.

Result: LineFormat

---

getName

Name	Description
getName()	Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String.

Result: String

---

getOfficeInteropShapeId

Name	Description
getOfficeInteropShapeId()	Gets unique shape identifier in slide scope. Read-only long. See also ( #getUniqueId) for getting unique shape identifier in presentation scope.

Result: long

---

getParentGroup

Name	Description
getParentGroup()	Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape. Property ( #isGrouped) determines whether the shape is grouped.

Result: GroupShape

---

getParent_Immediate

Name	Description
getParent_Immediate()

---

getPlaceholder

Name	Description
getPlaceholder()	Returns the placeholder for a shape. Returns null if the shape has no placeholder. Read-only IPlaceholder.

Result: Placeholder

---

getPresentation

Name	Description
getPresentation()	Returns the parent presentation of a slide. Read-only IPresentation.

Result: Presentation

---

getRawFrame

Name	Description
getRawFrame()	Returns or sets the raw shape frame’s properties. Read/write IShapeFrame.

Result: ShapeFrame

---

getRightToLeft

Name	Description
getRightToLeft()	Determines whether the table has right to left reading order. Read-write boolean.

Result: boolean

---

getRotation

Name	Description
getRotation()	Returns or 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 float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float

---

getRows

Name	Description
getRows()	Returns the collectoin of rows. Read-only IRowCollection.

Result: RowCollection

---

getShapeLock

Name	Description
getShapeLock()	Returns shape’s locks. Read-only IBaseShapeLock.

Result: BaseShapeLock, PictureFrameLock, AutoShapeLock, GraphicalObjectLock, GroupShapeLock, ConnectorLock

---

getSlide

Name	Description
getSlide()	Returns the parent slide of a shape. Read-only IBaseSlide.

Result: Slide, MasterNotesSlide, BaseSlide, MasterSlide, LayoutSlide, MasterHandoutSlide, NotesSlide

---

getStylePreset

Name	Description
getStylePreset()	Gets or sets builtin table style. Read/write TableStylePreset.

Result: int

---

getTableFormat

Name	Description
getTableFormat()	Returns the TableFormat object that contains formatting properties for this table. Read-only ITableFormat.

Result: TableFormat

---

getThreeDFormat

Name	Description
getThreeDFormat()	Returns the ThreeDFormat object that 3d effect properties for a shape. Note: can return null for certain types of shapes which don’t have 3d properties. Read-only IThreeDFormat.

Result: ThreeDFormat

---

getThumbnail

Name	Description
getThumbnail()	Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.

Result: BufferedImage

---

getThumbnail

Name	Description
getThumbnail(int, float, float)	Returns shape thumbnail.

Parameters:

Name	Type	Description
bounds	int	Shape thumbnail bounds type.
scaleX	float	X scale
scaleY	float	Y scale

Result: BufferedImage

---

getUniqueId

Name	Description
getUniqueId()	Gets unique shape identifier in presentation scope. Read-only long. See also ( #getOfficeInteropShapeId) for getting unique shape identifier in slide scope.

Result: long

---

getVerticalBanding

Name	Description
getVerticalBanding()	Determines whether the even columns has to be drawn with a different formatting. Read/write boolean.

Result: boolean

---

getWidth

Name	Description
getWidth()	Returns or sets the width of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float

---

getX

Name	Description
getX()	Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float

---

getY

Name	Description
getY()	Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float

---

getZOrderPosition

Name	Description
getZOrderPosition()	Returns the position of a shape in the z-order. 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. Read-only int.

Result: int

---

get_Item

Name	Description
get_Item(int, int)	Returns the cell at the specified column and row indexes. Read-only Cell.

Result: Cell

---

isGrouped

Name	Description
isGrouped()	Determines whether the shape is grouped. Read-only boolean. Property ( #getParentGroup) returns parent GroupShape object if shape is grouped.

Result: boolean

---

isTextHolder

Name	Description
isTextHolder()	Determines whether the shape is TextHolder_PPT. Read-only boolean.

Result: boolean

---

mergeCells

Name	Description
mergeCells(Cell, Cell, boolean)	Merges neighbour cells.

Parameters:

Name	Type	Description
cell1	Cell	Cell to merge.
cell2	Cell	Cell to merge.
allowSplitting	boolean	True to allow cells splitting.

Result: Cell

---

removePlaceholder

Name	Description
removePlaceholder()	Defines that this shape isn’t a placeholder.

---

setAlternativeText

Name	Description
setAlternativeText(String)	Returns or sets the alternative text associated with a shape. Read/write String.

---

setAlternativeTextTitle

Name	Description
setAlternativeTextTitle(String)	Returns or sets the title of alternative text associated with a shape. Read/write String.

---

setBlackWhiteMode

Name	Description
setBlackWhiteMode(byte)	Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode.

---

setFirstCol

Name	Description
setFirstCol(boolean)	Determines whether the first column of a table has to be drawn with a special formatting. Read/write boolean.

---

setFirstRow

Name	Description
setFirstRow(boolean)	Determines whether the first row of a table has to be drawn with a special formatting. Read/write boolean.

---

setFrame

Name	Description
setFrame(ShapeFrame)	Returns or sets the shape frame’s properties. Read/write IShapeFrame. Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties.

---

setHeight

Name	Description
setHeight(float)	Returns or sets the height of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

---

setHidden

Name	Description
setHidden(boolean)	Determines whether the shape is hidden. Read/write boolean.

---

setHorizontalBanding

Name	Description
setHorizontalBanding(boolean)	Determines whether the even rows has to be drawn with a different formatting. Read/write boolean.

---

setHyperlinkClick

Name	Description
setHyperlinkClick(Hyperlink)	Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink.

---

setHyperlinkMouseOver

Name	Description
setHyperlinkMouseOver(Hyperlink)	Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink.

---

setLastCol

Name	Description
setLastCol(boolean)	Determines whether the last column of a table has to be drawn with a special formatting. Read/write boolean.

---

setLastRow

Name	Description
setLastRow(boolean)	Determines whether the last row of a table has to be drawn with a special formatting. Read/write boolean.

---

setName

Name	Description
setName(String)	Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String.

---

setRawFrame

Name	Description
setRawFrame(ShapeFrame)	Returns or sets the raw shape frame’s properties. Read/write IShapeFrame.

---

setRightToLeft

Name	Description
setRightToLeft(boolean)	Determines whether the table has right to left reading order. Read-write boolean.

---

setRotation

Name	Description
setRotation(float)	Returns or 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 float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

---

setStylePreset

Name	Description
setStylePreset(int)	Gets or sets builtin table style. Read/write TableStylePreset.

---

setTextFormat

Name	Description
setTextFormat(PortionFormat)	Sets defined portion format properties to all table cells’ portions.

Parameters:

Name	Type	Description
source	PortionFormat	IPortionFormat object with necessary properties set.

---

setTextFormat

Name	Description
setTextFormat(ParagraphFormat)	Sets defined paragraph format properties to all table cells’ paragraphs.

Parameters:

Name	Type	Description
source	ParagraphFormat	IParagraphFormat object with necessary properties set.

---

setTextFormat

Name	Description
setTextFormat(TextFrameFormat)	Sets defined text frame format properties to all table cells’ text frames.

Parameters:

Name	Type	Description
source	TextFrameFormat	ITextFrameFormat object with necessary properties set.

---

setVerticalBanding

Name	Description
setVerticalBanding(boolean)	Determines whether the even columns has to be drawn with a different formatting. Read/write boolean.

---

setWidth

Name	Description
setWidth(float)	Returns or sets the width of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

---

setX

Name	Description
setX(float)	Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

---

setY

Name	Description
setY(float)	Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

---

writeAsSvgToBytes

Name	Description
writeAsSvgToBytes ()	Saves content of Shape as SVG file.

Result: Bytes[]

---

writeAsSvgToBytes

Name	Description
writeAsSvgToBytes (SVGOptions)	Saves content of Shape as SVG file.

Parameters:

Name	Type	Description
svgOptions	SVGOptions	SVG generation options

Result: Bytes[]

---