Table

Table class

Represents a table on a slide.

addPlaceholder

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

Parameters:

NameTypeDescription
placeholderToCopyFromPlaceholderPlaceholder to copy content from.

Result: Placeholder


getAlternativeText

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

Result: String


getAlternativeTextTitle

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

Result: String


getBasePlaceholder

NameDescription
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

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

Result: byte


getColumns

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

Result: ColumnCollection


getConnectionSiteCount

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

Result: int


getCustomData

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

Result: CustomData


getEffectFormat

NameDescription
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

NameDescription
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

NameDescription
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

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

Result: boolean


getFirstRow

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

Result: boolean


getFrame

NameDescription
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

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

Result: GraphicalObjectLock


getHeight

NameDescription
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

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

Result: boolean


getHorizontalBanding

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

Result: boolean


getHyperlinkClick

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

Result: Hyperlink


getHyperlinkManager

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

Result: HyperlinkManager


getHyperlinkMouseOver

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

Result: Hyperlink


getLastCol

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

Result: boolean


getLastRow

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

Result: boolean


getLineFormat

NameDescription
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

NameDescription
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

NameDescription
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

NameDescription
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

NameDescription
getParent_Immediate()

getPlaceholder

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

Result: Placeholder


getPresentation

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

Result: Presentation


getRawFrame

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

Result: ShapeFrame


getRightToLeft

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

Result: boolean


getRotation

NameDescription
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

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

Result: RowCollection


getShapeLock

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

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


getSlide

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

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


getStylePreset

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

Result: int


getTableFormat

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

Result: TableFormat


getThreeDFormat

NameDescription
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

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

Result: BufferedImage


getThumbnail

NameDescription
getThumbnail(int, float, float)Returns shape thumbnail.

Parameters:

NameTypeDescription
boundsintShape thumbnail bounds type.
scaleXfloatX scale
scaleYfloatY scale

Result: BufferedImage


getUniqueId

NameDescription
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

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

Result: boolean


getWidth

NameDescription
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

NameDescription
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

NameDescription
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

NameDescription
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

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

Result: Cell


isGrouped

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

Result: boolean


isTextHolder

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

Result: boolean


mergeCells

NameDescription
mergeCells(Cell, Cell, boolean)Merges neighbour cells.

Parameters:

NameTypeDescription
cell1CellCell to merge.
cell2CellCell to merge.
allowSplittingbooleanTrue to allow cells splitting.

Result: Cell


removePlaceholder

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

setAlternativeText

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

setAlternativeTextTitle

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

setBlackWhiteMode

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

setFirstCol

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

setFirstRow

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

setFrame

NameDescription
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

NameDescription
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

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

setHorizontalBanding

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

setHyperlinkClick

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

setHyperlinkMouseOver

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

setLastCol

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

setLastRow

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

setName

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

setRawFrame

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

setRightToLeft

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

setRotation

NameDescription
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

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

setTextFormat

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

Parameters:

NameTypeDescription
sourcePortionFormatIPortionFormat object with necessary properties set.

setTextFormat

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

Parameters:

NameTypeDescription
sourceParagraphFormatIParagraphFormat object with necessary properties set.

setTextFormat

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

Parameters:

NameTypeDescription
sourceTextFrameFormatITextFrameFormat object with necessary properties set.

setVerticalBanding

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

setWidth

NameDescription
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

NameDescription
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

NameDescription
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

NameDescription
writeAsSvgToBytes ()Saves content of Shape as SVG file.

Result: Bytes[]


writeAsSvgToBytes

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

Parameters:

NameTypeDescription
svgOptionsSVGOptionsSVG generation options

Result: Bytes[]