ICell

All Implemented Interfaces: com.aspose.slides.ISlideComponent

public interface ICell extends ISlideComponent

Represents a cell in a table.

Methods

Method Description
getOffsetX() Returns a distance from left side of a table to left side of a cell.
getOffsetY() Returns a distance from top side of a table to top side of a cell.
getFirstRowIndex() Returns an index of first row, covered by the cell.
getFirstColumnIndex() Returns an index of first column, covered by the cell.
getWidth() Returns the width of the cell.
getHeight() Returns the height of the cell.
getMinimalHeight() Returns the minimum height of a cell.
getMarginLeft() Returns or sets the left margin in a TextFrame.
setMarginLeft(double value) Returns or sets the left margin in a TextFrame.
getMarginRight() Returns or sets the right margin in a TextFrame.
setMarginRight(double value) Returns or sets the right margin in a TextFrame.
getMarginTop() Returns or sets the top margin in a TextFrame.
setMarginTop(double value) Returns or sets the top margin in a TextFrame.
getMarginBottom() Returns or sets the bottom margin in a TextFrame.
setMarginBottom(double value) Returns or sets the bottom margin in a TextFrame.
getTextVerticalType() Returns or sets the type of vertical text.
setTextVerticalType(byte value) Returns or sets the type of vertical text.
getTextAnchorType() Returns or sets the text anchor type.
setTextAnchorType(byte value) Returns or sets the text anchor type.
getAnchorCenter() Determines whether or not text box centered inside a cell.
setAnchorCenter(boolean value) Determines whether or not text box centered inside a cell.
getFirstColumn() Gets first column of cell.
getFirstRow() Gets first row of cell.
getColSpan() Returns the number of grid columns in the parent table’s table grid which shall be spanned by the current cell.
getRowSpan() Returns the number of rows that a merged cell spans.
getTextFrame() Returns the text frame of a cell.
getTable() Returns the parent Table object for a cell.
isMergedCell() Returns true if the cell is merged with any adjusted cell, false otherwise.
getCellFormat() Returns the CellFormat object that contains formatting properties for this cell.
splitByColSpan(int index) Splits the cell to two cells by index of column.
splitByRowSpan(int index) Splits the cell to two cells by index of row.
splitByHeight(double height) Splits the cell by height.
splitByWidth(double width) Splits the cell by width.

getOffsetX()

public abstract double getOffsetX()

Returns a distance from left side of a table to left side of a cell. Read-only double.

Returns: double

getOffsetY()

public abstract double getOffsetY()

Returns a distance from top side of a table to top side of a cell. Read-only double.

Returns: double

getFirstRowIndex()

public abstract int getFirstRowIndex()

Returns an index of first row, covered by the cell. Read-only int.

Returns: int

getFirstColumnIndex()

public abstract int getFirstColumnIndex()

Returns an index of first column, covered by the cell. Read-only int.

Returns: int

getWidth()

public abstract double getWidth()

Returns the width of the cell. Read-only double.

Returns: double

getHeight()

public abstract double getHeight()

Returns the height of the cell. Read-only double.

Returns: double

getMinimalHeight()

public abstract double getMinimalHeight()

Returns the minimum height of a cell. This is a sum of minimal heights of all rows cowered by the cell. Read-only double.

Returns: double

getMarginLeft()

public abstract double getMarginLeft()

Returns or sets the left margin in a TextFrame. Read/write double.

Returns: double

setMarginLeft(double value)

public abstract void setMarginLeft(double value)

Returns or sets the left margin in a TextFrame. Read/write double.

Parameters:

Parameter Type Description
value double

getMarginRight()

public abstract double getMarginRight()

Returns or sets the right margin in a TextFrame. Read/write double.

Returns: double

setMarginRight(double value)

public abstract void setMarginRight(double value)

Returns or sets the right margin in a TextFrame. Read/write double.

Parameters:

Parameter Type Description
value double

getMarginTop()

public abstract double getMarginTop()

Returns or sets the top margin in a TextFrame. Read/write double.

Returns: double

setMarginTop(double value)

public abstract void setMarginTop(double value)

Returns or sets the top margin in a TextFrame. Read/write double.

Parameters:

Parameter Type Description
value double

getMarginBottom()

public abstract double getMarginBottom()

Returns or sets the bottom margin in a TextFrame. Read/write double.

Returns: double

setMarginBottom(double value)

public abstract void setMarginBottom(double value)

Returns or sets the bottom margin in a TextFrame. Read/write double.

Parameters:

Parameter Type Description
value double

getTextVerticalType()

public abstract byte getTextVerticalType()

Returns or sets the type of vertical text. Read/write TextVerticalType.

Returns: byte

setTextVerticalType(byte value)

public abstract void setTextVerticalType(byte value)

Returns or sets the type of vertical text. Read/write TextVerticalType.

Parameters:

Parameter Type Description
value byte

getTextAnchorType()

public abstract byte getTextAnchorType()

Returns or sets the text anchor type. Read/write TextAnchorType.

Returns: byte

setTextAnchorType(byte value)

public abstract void setTextAnchorType(byte value)

Returns or sets the text anchor type. Read/write TextAnchorType.

Parameters:

Parameter Type Description
value byte

getAnchorCenter()

public abstract boolean getAnchorCenter()

Determines whether or not text box centered inside a cell. Read/write boolean.

Returns: boolean

setAnchorCenter(boolean value)

public abstract void setAnchorCenter(boolean value)

Determines whether or not text box centered inside a cell. Read/write boolean.

Parameters:

Parameter Type Description
value boolean

getFirstColumn()

public abstract IColumn getFirstColumn()

Gets first column of cell. Read-only IColumn.

Returns: IColumn

getFirstRow()

public abstract IRow getFirstRow()

Gets first row of cell. Read-only IRow.

Returns: IRow

getColSpan()

public abstract int getColSpan()

Returns the number of grid columns in the parent table’s table grid which shall be spanned by the current cell. This property allows cells to have the appearance of being merged, as they span vertical boundaries of other cells in the table. Read-only int.

Returns: int

getRowSpan()

public abstract int getRowSpan()

Returns the number of rows that a merged cell spans. This is used in combination with the vMerge attribute on other cells in order to specify the beginning cell of a horizontal merge. Read-only int.

Returns: int

getTextFrame()

public abstract ITextFrame getTextFrame()

Returns the text frame of a cell. Read-only ITextFrame.

Returns: ITextFrame

getTable()

public abstract ITable getTable()

Returns the parent Table object for a cell. Read-only ITable.

Returns: ITable

isMergedCell()

public abstract boolean isMergedCell()

Returns true if the cell is merged with any adjusted cell, false otherwise. Read-only boolean.

Returns: boolean

getCellFormat()

public abstract ICellFormat getCellFormat()

Returns the CellFormat object that contains formatting properties for this cell. Read-only ICellFormat.

Returns: ICellFormat

splitByColSpan(int index)

public abstract void splitByColSpan(int index)

Splits the cell to two cells by index of column.

Parameters:

Parameter Type Description
index int Index of column.

splitByRowSpan(int index)

public abstract void splitByRowSpan(int index)

Splits the cell to two cells by index of row.

Parameters:

Parameter Type Description
index int Index of row.

splitByHeight(double height)

public abstract void splitByHeight(double height)

Splits the cell by height.

Parameters:

Parameter Type Description
height double Height of a row.

splitByWidth(double width)

public abstract void splitByWidth(double width)

Splits the cell by width.

Parameters:

Parameter Type Description
width double Width of a column.