Cells

Cells class

Encapsulates a collection of cell relevant objects, such as Cell , Row , …etc.

Properties

Name	Type	Description
OdsCellFields	OdsCellFieldCollection	Gets the list of fields of ods.
Count	int	Gets the total count of instantiated Cell objects.
CountLarge	long	Gets the total count of instantiated Cell objects.
Rows	RowCollection	Gets the collection of Row objects that represents the individual rows in this worksheet.
MergedCells	ArrayList	Gets the collection of merged cells. In this collection, each item is a CellArea structure which represents an area of m
MultiThreadReading	boolean	Gets or sets whether the cells data model should support Multi-Thread reading. Default value of this property is false.
MemorySetting	int	Gets or sets the memory usage option for this cells. The value of the property is MemorySetting integer constant.
Style	Style	Gets and sets the default style of the worksheet.
IsDefaultColumnHidden	boolean
StandardWidthInch	float	Gets or sets the default column width in the worksheet, in unit of inches.
StandardWidthPixels	int	Gets or sets the default column width in the worksheet, in unit of pixels.
StandardWidth	float	Gets or sets the default column width in the worksheet, in unit of characters.
StandardHeight	float	Gets or sets the default row height in this worksheet, in unit of points.
StandardHeightPixels	int	Gets or sets the default row height in this worksheet, in unit of pixels.
StandardHeightInch	float	Gets or sets the default row height in this worksheet, in unit of inches.
PreserveString	boolean	Gets or sets a value indicating whether all worksheet values are preserved as strings. Default is false.
MinRow	int	Minimum row index of cell which contains data or style.
MaxRow	int	Maximum row index of cell which contains data or style. Return -1 if there is no cell which contains data or style in th
MinColumn	int	Minimum column index of those cells that have been instantiated in the collection(does not include the column where styl
MaxColumn	int	Maximum column index of those cells that have been instantiated in the collection(does not include the column where styl
MinDataRow	int	Minimum row index of cell which contains data.
MaxDataRow	int	Maximum row index of cell which contains data. Return -1 if there is no cell which contains data.
MinDataColumn	int	Minimum column index of cell which contains data. -1 will be returned if there is no cell which contains data. This prop
MaxDataColumn	int	Maximum column index of cell which contains data. -1 will be returned if there is no cell which contains data. This prop
IsDefaultRowHeightMatched	boolean	Indicates that row height and default font height matches
IsDefaultRowHidden	boolean	Indicates whether the row is default hidden.
Columns	ColumnCollection	Gets the collection of Column objects that represents the individual columns in this worksheet.
Ranges	RangeCollection	Gets the collection of Range objects created at run time.
LastCell	Cell	Gets the last cell in this worksheet. Returns null if there is no data in the worksheet.
MaxDisplayRange	Range	Gets the max range which includes data, merged cells and shapes. Reutrns null if the worksheet is empty since Aspose.Cel
FirstCell	Cell	Gets the first cell in this worksheet. Returns null if there is no data in the worksheet.
Item (int, int)	Cell	Gets the Cell element at the specified cell row index and column index.
Item (java.lang.String)	Cell	Gets the Cell element at the specified cell name.

Methods

Name	Description
insertRange	Inserts a range of cells and shift cells according to the shift option.
deleteRange	Deletes a range of cells and shift cells according to the shift option.
retrieveSubtotalSetting	Retrieves subtotals setting of the range.
subtotal	Creates subtotals for the range.
removeFormulas	Removes all formula and replaces with the value of the formula.
removeDuplicates	Removes duplicate rows in the sheet.
convertStringToNumericValue	Converts all string data in the worksheet to numeric value if possible.
getDependents	Get all cells which refer to the specific cell.
getDependentsInCalculation	Gets all cells whose calculated result depends on specific cell.

To use this method, please make sure the workbook has | | getCellsWithPlaceInCellPicture | Gets all cells that contain embedded picture.

If the row is not grouped, returns zero. | | getGroupedColumnOutlineLevel | Gets the outline level (zero-based) of the column.

When traversing elements by the returned Enumerator, the cells collection should not be modi | | getRowEnumerator | Gets the rows enumerator.

NOTE: This member is now obsolete. Instead, please use | | getColumnOriginalWidthPoint | Gets original column’s height in unit of point if the column is hidden

To hide a column, sets column width to zero. | | getColumnWidthPixel | Gets the width of the specified column in normal view, in units of pixel. | | getColumnWidthInch | Gets the width of the specified column in normal view, in units of inches.

NOTE: This method is now obsolete. Instead, | | importCSVFromBytes | Import a CSV file to the cells. |

Cells.OdsCellFields property

Gets the list of fields of ods.

Type: OdsCellFieldCollection

Cells.Count property

Gets the total count of instantiated Cell objects.

Type: int

Cells.CountLarge property

Gets the total count of instantiated Cell objects.

Type: long

Cells.Rows property

Gets the collection of Row objects that represents the individual rows in this worksheet.

Type: RowCollection

Cells.MergedCells property

Gets the collection of merged cells. In this collection, each item is a CellArea structure which represents an area of merged cells.

Type: ArrayList

Cells.MultiThreadReading property

Gets or sets whether the cells data model should support Multi-Thread reading. Default value of this property is false. If there are multiple threads to read Row/Cell objects in this collection concurrently, this property should be set as true, otherwise unexpected result may be produced. Supporting Multi-Thread reading may degrade the performance for accessing Row/Cell objects from this collection. Please note, some features cannot support Multi-Thread reading, such as formatting values(by Cell.StringValue , Cell.DisplayStringValue , .etc.). So, even with this property being set as true, those APIs still may give unexpected result for Multi-Thread reading.

Type: boolean

Cells.MemorySetting property

Gets or sets the memory usage option for this cells. The value of the property is MemorySetting integer constant.

Type: int

Cells.Style property

Gets and sets the default style of the worksheet.

Type: Style

Cells.IsDefaultColumnHidden property

Type: boolean

Cells.StandardWidthInch property

Gets or sets the default column width in the worksheet, in unit of inches.

Type: float

Cells.StandardWidthPixels property

Gets or sets the default column width in the worksheet, in unit of pixels.

Type: int

Cells.StandardWidth property

Gets or sets the default column width in the worksheet, in unit of characters.

Type: float

Cells.StandardHeight property

Gets or sets the default row height in this worksheet, in unit of points.

Type: float

Cells.StandardHeightPixels property

Gets or sets the default row height in this worksheet, in unit of pixels.

Type: int

Cells.StandardHeightInch property

Gets or sets the default row height in this worksheet, in unit of inches.

Type: float

Cells.PreserveString property

Gets or sets a value indicating whether all worksheet values are preserved as strings. Default is false.

Type: boolean

Cells.MinRow property

Minimum row index of cell which contains data or style.

Type: int

Cells.MaxRow property

Maximum row index of cell which contains data or style. Return -1 if there is no cell which contains data or style in the worksheet.

Type: int

Cells.MinColumn property

Minimum column index of those cells that have been instantiated in the collection(does not include the column where style is defined for the whole column but no cell has been instantiated in it).

Type: int

Cells.MaxColumn property

Maximum column index of those cells that have been instantiated in the collection(does not include the column where style is defined for the whole column but no cell has been instantiated in it). Return -1 if there is no cell.

Type: int

Cells.MinDataRow property

Minimum row index of cell which contains data.

Type: int

Cells.MaxDataRow property

Maximum row index of cell which contains data. Return -1 if there is no cell which contains data.

Type: int

Cells.MinDataColumn property

Minimum column index of cell which contains data. -1 will be returned if there is no cell which contains data. This property needs to iterate and check all cells in a worksheet, so it is a time-consumed progress and should not be invoked repeatedly.

Type: int

Cells.MaxDataColumn property

Maximum column index of cell which contains data. -1 will be returned if there is no cell which contains data. This property needs to iterate and check all cells in a worksheet, so it is a time-consumed progress and should not be invoked repeatedly.

Type: int

Cells.IsDefaultRowHeightMatched property

Indicates that row height and default font height matches

Type: boolean

Cells.IsDefaultRowHidden property

Indicates whether the row is default hidden.

Type: boolean

Cells.Columns property

Gets the collection of Column objects that represents the individual columns in this worksheet.

Type: ColumnCollection

Cells.Ranges property

Gets the collection of Range objects created at run time.

Type: RangeCollection

Cells.LastCell property

Gets the last cell in this worksheet. Returns null if there is no data in the worksheet.

Type: Cell

Cells.MaxDisplayRange property

Gets the max range which includes data, merged cells and shapes. Reutrns null if the worksheet is empty since Aspose.Cells 21.5.2.

Type: Range

Cells.FirstCell property

Gets the first cell in this worksheet. Returns null if there is no data in the worksheet.

Type: Cell

Cells.Item (int, int) property

Gets the Cell element at the specified cell row index and column index.

Type: Cell

Cells.Item (java.lang.String) property

Gets the Cell element at the specified cell name.

Type: Cell

insertRange(area, shiftNumber, shiftType, updateReference) (1 of 3)

Inserts a range of cells and shift cells according to the shift option.

Parameter	Type	Description
area	CellArea	Shift area.
shiftNumber	int	Number of rows or columns to be inserted.
shiftType	int	A ShiftType value. Shift cells option.
updateReference	boolean	Indicates whether update references in other worksheets.

insertRange(area, shiftType) (2 of 3)

Inserts a range of cells and shift cells according to the shift option.

Parameter	Type	Description
area	CellArea	Shift area.
shiftType	int	A ShiftType value. Shift cells option.

insertRange(area, shiftNumber, shiftType) (3 of 3)

Inserts a range of cells and shift cells according to the shift option.

Parameter	Type	Description
area	CellArea	Shift area.
shiftNumber	int	Number of rows or columns to be inserted.
shiftType	int	A ShiftType value. Shift cells option.

deleteRange(startRow, startColumn, endRow, endColumn, shiftType)

Deletes a range of cells and shift cells according to the shift option.

Parameter	Type	Description
startRow	int	Start row index.
startColumn	int	Start column index.
endRow	int	End row index.
endColumn	int	End column index.
shiftType	int	A ShiftType value. Shift cells option.

retrieveSubtotalSetting(ca)

Retrieves subtotals setting of the range.

Parameter	Type	Description
ca	CellArea	The range

subtotal(ca, groupBy, function, totalList) (1 of 2)

Creates subtotals for the range.

Parameter	Type	Description
ca	CellArea	The range
groupBy	int	The field to group by, as a zero-based integer offset
function	int	A ConsolidationFunction value. The subtotal function.
totalList	Number Array	An array of zero-based field offsets, indicating the fields to which the subtotals are added.

subtotal(ca, groupBy, function, totalList, replace, pageBreaks, summaryBelowData) (2 of 2)

Creates subtotals for the range.

Parameter	Type	Description
ca	CellArea	The range
groupBy	int	The field to group by, as a zero-based integer offset
function	int	A ConsolidationFunction value. The subtotal function.
totalList	Number Array	An array of zero-based field offsets, indicating the fields to which the subtotals are added.
replace	boolean	Indicates whether replace the current subtotals
pageBreaks	boolean	Indicates whether add page break between groups
summaryBelowData	boolean	Indicates whether add summary below data.

removeFormulas()

Removes all formula and replaces with the value of the formula.

removeDuplicates() (1 of 3)

Removes duplicate rows in the sheet.

removeDuplicates(startRow, startColumn, endRow, endColumn) (2 of 3)

Removes duplicate values in the range.

Parameter	Type	Description
startRow	int	The start row.
startColumn	int	The start column
endRow	int	The end row index.
endColumn	int	The end column index.

removeDuplicates(startRow, startColumn, endRow, endColumn, hasHeaders, columnOffsets) (3 of 3)

Removes duplicate data of the range.

Parameter	Type	Description
startRow	int	The start row.
startColumn	int	The start column
endRow	int	The end row index.
endColumn	int	The end column index.
hasHeaders	boolean	Indicates whether the range contains headers.
columnOffsets	Number Array	The column offsets.

convertStringToNumericValue()

Converts all string data in the worksheet to numeric value if possible.

getDependents(isAll, row, column)

Get all cells which refer to the specific cell.

Parameter	Type	Description
isAll	boolean	Indicates whether check other worksheets
row	int	The row index.
column	int	The column index.

getDependentsInCalculation(row, column, recursive)

Gets all cells whose calculated result depends on specific cell.

To use this method, please make sure the workbook has been set with true value for FormulaSettings.EnableCalculationChain and has been fully calculated with this setting. If there is no formula reference to this cell, null will be returned. For more details and example, please see Cell.getDependentsInCalculation(boolean)

Parameter	Type	Description
row	int	Row index of the specific cell
column	int	Column index of the specific cell.
recursive	boolean	Whether returns those dependents which do not reference to the specific cell directly but reference to other leafs of that cell.

Returns: Enumerator to enumerate all dependents(Cell objects)

getCellsWithPlaceInCellPicture()

Gets all cells that contain embedded picture.

If there is no picture which is set as “Place in Cell” in this worksheet, null will be returned. />

Returns: Enumerator to enumerate all Cell objects that contain embedded picture

getCellStyle(row, column)

Get the style of given cell.

Parameter	Type	Description
row	int	row index
column	int	column

Returns: the style of given cell.

getCellDisplayStyle(row, column) (1 of 2)

getCellDisplayStyle(row, column, adjacentBorders) (2 of 2)

getColumnWidth(column) (1 of 2)

Gets the width(in unit of characters) of the specified column in normal view

Parameter	Type	Description
column	int	Column index

Returns: Width of column. For spreadsheet, column width is measured as the number of characters of the maximum digit width of the numbers 0~9 as rendered in the normal style’s font.

getColumnWidth(column, isOriginal, unitType) (2 of 2)

Gets the column width.

Parameter	Type	Description
column	int	The column index.
isOriginal	boolean	Indicates whether getting original width.
unitType	int	A CellsUnitType value.

getViewColumnWidthPixel(column)

Get the width in different view type.

Parameter	Type	Description
column	int	The column index.

Returns: the column width in unit of pixels

setViewColumnWidthPixel(column, pixels)

Sets the width of the column in different view.

If the current view type is ViewType.PAGE_LAYOUT_VIEW , the column’s width is same as printed width.

Parameter	Type	Description
column	int	The column index.
pixels	int	The width in unit of pixels.

getLastDataRow(column)

Gets the last row index of cell which contains data in the specified column.

Parameter	Type	Description
column	int	Column index.

Returns: last row index.

getFirstDataRow(column)

applyColumnStyle(column, style, flag)

Applies formats for a whole column.

Parameter	Type	Description
column	int	The column index.
style	Style	The style object which will be applied.
flag	StyleFlag	Flags which indicates applied formatting properties.

applyRowStyle(row, style, flag)

Applies formats for a whole row.

Parameter	Type	Description
row	int	The row index.
style	Style	The style object which will be applied.
flag	StyleFlag	Flags which indicates applied formatting properties.

applyStyle(style, flag)

Applies formats for a whole worksheet.

Parameter	Type	Description
style	Style	The style object which will be applied.
flag	StyleFlag	Flags which indicates applied formatting properties.

copyColumns(sourceCells, sourceColumnIndex, destinationColumnIndex, columnNumber, pasteOptions) (1 of 3)

Copies data and formats of a whole column.

Parameter	Type	Description
sourceCells0		Source Cells object contains data and formats to copy.
sourceColumnIndex	int	Source column index.
destinationColumnIndex	int	Destination column index.
columnNumber	int	The copied column number.
pasteOptions	PasteOptions	the options of pasting.

copyColumns(sourceCells, sourceColumnIndex, destinationColumnIndex, columnNumber) (2 of 3)

Copies data and formats of a whole column.

Parameter	Type	Description
sourceCells0		Source Cells object contains data and formats to copy.
sourceColumnIndex	int	Source column index.
destinationColumnIndex	int	Destination column index.
columnNumber	int	The copied column number.

copyColumns(sourceCells, sourceColumnIndex, sourceTotalColumns, destinationColumnIndex, destinationTotalColumns) (3 of 3)

Copies data and formats of the whole columns.

Parameter	Type	Description
sourceCells	Cells	Source Cells object contains data and formats to copy.
sourceColumnIndex	int	Source column index.
sourceTotalColumns	int	The number of the source columns.
destinationColumnIndex	int	Destination column index.
destinationTotalColumns	int	The number of the destination columns.

copyColumn(sourceCells, sourceColumnIndex, destinationColumnIndex)

Copies data and formats of a whole column.

Parameter	Type	Description
sourceCells	Cells	Source Cells object contains data and formats to copy.
sourceColumnIndex	int	Source column index.
destinationColumnIndex	int	Destination column index.

copyRow(sourceCells, sourceRowIndex, destinationRowIndex)

Copies data and formats of a whole row.

Parameter	Type	Description
sourceCells	Cells	Source Cells object contains data and formats to copy.
sourceRowIndex	int	Source row index.
destinationRowIndex	int	Destination row index.

copyRows(sourceCells, sourceRowIndex, destinationRowIndex, rowNumber) (1 of 3)

Copies data and formats of some whole rows.

Parameter	Type	Description
sourceCells	Cells	Source Cells object contains data and formats to copy.
sourceRowIndex	int	Source row index.
destinationRowIndex	int	Destination row index.
rowNumber	int	The copied row number.

copyRows(sourceCells, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions) (2 of 3)

Copies data and formats of some whole rows.

Parameter	Type	Description
sourceCells0		Source Cells object contains data and formats to copy.
sourceRowIndex	int	Source row index.
destinationRowIndex	int	Destination row index.
rowNumber	int	The copied row number.
copyOptions	CopyOptions	The copy options.

copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions, pasteOptions) (3 of 3)

Copies data and formats of some whole rows.

Parameter	Type	Description
sourceCells0	Cells	Source Cells object contains data and formats to copy.
sourceRowIndex	int	Source row index.
destinationRowIndex	int	Destination row index.
rowNumber	int	The copied row number.
copyOptions	CopyOptions	The copy options.
pasteOptions	PasteOptions	the options of pasting.

getGroupedRowOutlineLevel(rowIndex)

Gets the outline level (zero-based) of the row.

If the row is not grouped, returns zero.

Parameter	Type	Description
rowIndex	int	The row index.

Returns: The outline level (zero-based) of the row.

getGroupedColumnOutlineLevel(columnIndex)

Gets the outline level (zero-based) of the column.

If the column is not grouped, returns zero.

Parameter	Type	Description
columnIndex	int	The column index

Returns: The outline level of the column

getMaxGroupedColumnOutlineLevel()

Gets the max grouped column outline level (zero-based).

Returns: The max grouped column outline level (zero-based)

getMaxGroupedRowOutlineLevel()

Gets the max grouped row outline level (zero-based).

Returns: The max grouped row outline level (zero-based)

showGroupDetail(isVertical, index)

Expands the grouped rows/columns.

Parameter	Type	Description
isVertical	boolean	True, expands the grouped rows.
index	int	The row/column index

hideGroupDetail(isVertical, index)

Collapses the grouped rows/columns.

Parameter	Type	Description
isVertical	boolean	True, collapse the grouped rows.
index	int	The row/column index

ungroupColumns(firstIndex, lastIndex)

Ungroups columns.

Parameter	Type	Description
firstIndex	int	The first column index to be ungrouped.
lastIndex	int	The last column index to be ungrouped.

groupColumns(firstIndex, lastIndex) (1 of 2)

Groups columns.

Parameter	Type	Description
firstIndex	int	The first column index to be grouped.
lastIndex	int	The last column index to be grouped.

groupColumns(firstIndex, lastIndex, isHidden) (2 of 2)

Groups columns.

Parameter	Type	Description
firstIndex	int	The first column index to be grouped.
lastIndex	int	The last column index to be grouped.
isHidden	boolean	Specifies if the grouped columns are hidden.

ungroupRows(firstIndex, lastIndex, isAll) (1 of 2)

Ungroups rows.

Parameter	Type	Description
firstIndex	int	The first row index to be ungrouped.
lastIndex	int	The last row index to be ungrouped.
isAll	boolean	True, removes all grouped info.Otherwise, remove the outer group info.

ungroupRows(firstIndex, lastIndex) (2 of 2)

Ungroups rows.

Only removes outer group info.

Parameter	Type	Description
firstIndex	int	The first row index to be ungrouped.
lastIndex	int	The last row index to be ungrouped.

groupRows(firstIndex, lastIndex, isHidden) (1 of 2)

Groups rows.

Parameter	Type	Description
firstIndex	int	The first row index to be grouped.
lastIndex	int	The last row index to be grouped.
isHidden	boolean	Specifies if the grouped rows are hidden.

groupRows(firstIndex, lastIndex) (2 of 2)

Groups rows.

Parameter	Type	Description
firstIndex	int	The first row index to be grouped.
lastIndex	int	The last row index to be grouped.

deleteColumn(columnIndex, updateReference) (1 of 2)

Deletes a column.

Parameter	Type	Description
columnIndex	int	Index of the column to be deleted.
updateReference	boolean	Indicates whether update references in other worksheets.

deleteColumn(columnIndex) (2 of 2)

Deletes a column.

Parameter	Type	Description
columnIndex	int	Index of the column to be deleted.

deleteColumns(columnIndex, totalColumns, updateReference) (1 of 2)

Deletes several columns.

Parameter	Type	Description
columnIndex	int	Index of the first column to be deleted.
totalColumns	int	Count of columns to be deleted.
updateReference	boolean	Indicates whether update references in other worksheets.

deleteColumns(columnIndex, totalColumns, options) (2 of 2)

isDeletingRangeEnabled(startRow, startColumn, totalRows, totalColumns)

Check whether the range could be deleted.

Parameter	Type	Description
startRow	int	The start row index of the range.
startColumn	int	The start column index of the range.
totalRows	int	The number of the rows in the range.
totalColumns	int	The number of the columns in the range.

deleteRow(rowIndex) (1 of 2)

Deletes a row.

Parameter	Type	Description
rowIndex	int	Index of the row to be deleted.

deleteRow(rowIndex, updateReference) (2 of 2)

Deletes a row.

Parameter	Type	Description
rowIndex	int	Index of the row to be deleted.
updateReference	boolean	Indicates whether update references in other worksheets.

deleteRows(rowIndex, totalRows) (1 of 3)

Deletes several rows.

If the deleted range contains the top part(not whole) of the table(ListObject), the ranged could not be deleted and nothing will be done. It works in the same way with MS Excel.

Parameter	Type	Description
rowIndex	int	The first row index to be deleted.
totalRows	int	Count of rows to be deleted.

deleteRows(rowIndex, totalRows, updateReference) (2 of 3)

Deletes multiple rows in the worksheet.

Parameter	Type	Description
rowIndex	int	Index of the first row to be deleted.
totalRows	int	Count of rows to be deleted.
updateReference	boolean	Indicates whether update references in other worksheets.

deleteRows(rowIndex, totalRows, options) (3 of 3)

deleteBlankColumns() (1 of 2)

Delete all blank columns which do not contain any data.

deleteBlankColumns(options) (2 of 2)

Delete all blank columns which do not contain any data.

Parameter	Type	Description
options	DeleteOptions	The options of deleting range.

isBlankColumn(columnIndex)

Checks whether given column is blank(does not contain any data).

Parameter	Type	Description
columnIndex	int	the column index

Returns: true if given column does not contain any data

deleteBlankRows() (1 of 2)

Delete all blank rows which do not contain any data or other object.

deleteBlankRows(options) (2 of 2)

Delete all blank rows which do not contain any data or other object.

For blank rows that will be deleted, it is not only required that Row.IsBlank should be true, but also there should be no visible comment defined for any cell in those rows, and no pivot table whose range intersects with them.

Parameter	Type	Description
options	DeleteOptions	The options of deleting range.

insertColumns(columnIndex, totalColumns) (1 of 3)

Inserts some columns into the worksheet.

Parameter	Type	Description
columnIndex	int	Column index.
totalColumns	int	The number of columns.

insertColumns(columnIndex, totalColumns, updateReference) (2 of 3)

Inserts some columns into the worksheet.

Parameter	Type	Description
columnIndex	int	Column index.
totalColumns	int	The number of columns.
updateReference	boolean	Indicates if references in other worksheets will be updated.

insertColumns(columnIndex, totalColumns, options) (3 of 3)

insertColumn(columnIndex, updateReference) (1 of 2)

Inserts a new column into the worksheet.

Parameter	Type	Description
columnIndex	int	Column index.
updateReference	boolean	Indicates if references in other worksheets will be updated.

insertColumn(columnIndex) (2 of 2)

Inserts a new column into the worksheet.

Parameter	Type	Description
columnIndex	int	Column index.

insertRows(rowIndex, totalRows, updateReference) (1 of 3)

Inserts multiple rows into the worksheet.

Parameter	Type	Description
rowIndex	int	Row index.
totalRows	int	Number of rows to be inserted.
updateReference	boolean	Indicates if references in other worksheets will be updated.

insertRows(rowIndex, totalRows, options) (2 of 3)

Inserts multiple rows into the worksheet.

Parameter	Type	Description
rowIndex	int	Row index.
totalRows	int	Number of rows to be inserted.
options	InsertOptions	Indicates if references in other worksheets will be updated.

insertRows(rowIndex, totalRows) (3 of 3)

Inserts multiple rows into the worksheet.

Parameter	Type	Description
rowIndex	int	Row index.
totalRows	int	Number of rows to be inserted.

insertRow(rowIndex)

Inserts a new row into the worksheet.

Parameter	Type	Description
rowIndex	int	Row index.

clearRange(range) (1 of 2)

Clears contents and formatting of a range.

Parameter	Type	Description
range	CellArea	Range to be cleared.

clearRange(startRow, startColumn, endRow, endColumn) (2 of 2)

Clears contents and formatting of a range.

Parameter	Type	Description
startRow	int	Start row index.
startColumn	int	Start column index.
endRow	int	End row index.
endColumn	int	End column index.

clearContents(range) (1 of 2)

Clears contents of a range.

Parameter	Type	Description
range	CellArea	Range to be cleared.

clearContents(startRow, startColumn, endRow, endColumn) (2 of 2)

Clears contents of a range.

Parameter	Type	Description
startRow	int	Start row index.
startColumn	int	Start column index.
endRow	int	End row index.
endColumn	int	End column index.

clearFormats(range) (1 of 2)

Clears formatting of a range.

Parameter	Type	Description
range	CellArea	Range to be cleared.

clearFormats(startRow, startColumn, endRow, endColumn) (2 of 2)

Clears formatting of a range.

Parameter	Type	Description
startRow	int	Start row index.
startColumn	int	Start column index.
endRow	int	End row index.
endColumn	int	End column index.

linkToXmlMap(mapName, row, column, path)

Link to a xml map.

Parameter	Type	Description
mapName	String	name of xml map
row	int	row of the destination cell
column	int	column of the destination cell
path	String	path of xml element in xml map

find(what, previousCell) (1 of 2)

Finds the cell containing with the input object.

Returns null (Nothing) if no cell is found.

Parameter	Type	Description
what	Object	The object to search for. The type should be int,double,DateTime,string,bool.
previousCell	Cell	Previous cell with the same object. This parameter can be set to null if searching from the start.

Returns: Cell object.

find(what, previousCell, findOptions) (2 of 2)

Finds the cell containing with the input object.

Returns null (Nothing) if no cell is found.

Parameter	Type	Description
what	Object	The object to search for. The type should be int,double,DateTime,string,bool.
previousCell	Cell	Previous cell with the same object. This parameter can be set to null if searching from the start.
findOptions	FindOptions	Find options

Returns: Cell object.

endCellInRow(rowIndex) (1 of 2)

Gets the last cell in this row.

Parameter	Type	Description
rowIndex	int	Row index.

Returns: Cell object.

endCellInRow(startRow, endRow, startColumn, endColumn) (2 of 2)

Gets the last cell with maximum row index in this range.

Parameter	Type	Description
startRow	int	Start row index.
endRow	int	End row index.
startColumn	int	Start column index.
endColumn	int	End column index.

Returns: Cell object.

endCellInColumn(columnIndex) (1 of 2)

endCellInColumn(startRow, endRow, startColumn, endColumn) (2 of 2)

moveRange(sourceArea, destRow, destColumn)

Moves the range.

Parameter	Type	Description
sourceArea	CellArea	The range which should be moved.
destRow	int	The dest row.
destColumn	int	The dest column.

insertCutCells(cutRange, row, column, shiftType)

Insert cut range.

Parameter	Type	Description
cutRange	Range	The cut range.
row	int	The row.
column	int	The column.
shiftType	int	A ShiftType value. The shift type .

dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

iterator()

Gets the cells enumerator.

When traversing elements by the returned Enumerator, the cells collection should not be modified(such as operations that will cause new Cell/Row be instantiated or existing Cell/Row be deleted). Otherwise the enumerator may not be able to traverse all cells correctly(some elements may be traversed repeatedly or skipped).

Returns: The cells enumerator

getRowEnumerator()

Gets the rows enumerator.

NOTE: This member is now obsolete. Instead, please use RowCollection.GetEnumerator() method. This method will be removed 12 months later since May 2023. Aspose apologizes for any inconvenience you may have experienced.

Returns: The rows enumerator.

See Also:

RowCollection.iterator()

getMergedAreas()

Gets all merged cells.

checkCell(row, column)

Gets the Cell element or null at the specified cell row index and column index.

Parameter	Type	Description
row	int	Row index
column	int	Column index

Returns: Return Cell object if a Cell object exists. Return null if the cell does not exist.

checkRow(row)

Gets the Row element or null at the specified cell row index.

Parameter	Type	Description
row	int	Row index

Returns: Returns Row object If the row object does exist, otherwise returns null.

checkColumn(columnIndex)

Gets the Column element or null at the specified column index.

Parameter	Type	Description
columnIndex	int	The column index.

Returns: The Column object.

isRowHidden(rowIndex)

Checks whether a row at given index is hidden.

Parameter	Type	Description
rowIndex	int	row index

Returns: true if the row is hidden

isColumnHidden(columnIndex)

Checks whether a column at given index is hidden.

Parameter	Type	Description
columnIndex	int	column index

Returns: true if the column is hidden.

addRange(rangeObject)

Adds a range object reference to cells

Parameter	Type	Description
rangeObject	Range	The range object will be contained in the cells

createRange(upperLeftCell, lowerRightCell) (1 of 4)

Creates a Range object from a range of cells.

Parameter	Type	Description
upperLeftCell	String	Upper left cell name.
lowerRightCell	String	Lower right cell name.

Returns: A Range object

createRange(firstRow, firstColumn, totalRows, totalColumns) (2 of 4)

Creates a Range object from a range of cells.

Parameter	Type	Description
firstRow	int	First row of this range
firstColumn	int	First column of this range
totalRows	int	Number of rows
totalColumns	int	Number of columns

Returns: A Range object

createRange(address) (3 of 4)

Creates a Range object from an address of the range.

Parameter	Type	Description
address	String	The address of the range.

Returns: A Range object

createRange(firstIndex, number, isVertical) (4 of 4)

Creates a Range object from rows of cells or columns of cells.

Parameter	Type	Description
firstIndex	int	First row index or first column index, zero based.
number	int	Total number of rows or columns, one based.
isVertical	boolean	True - Range created from columns of cells. False - Range created from rows of cells.

Returns: A Range object.

clear()

Clears all data of the worksheet.

importFormulaArray(stringArray, firstRow, firstColumn, isVertical)

Imports an array of formula into a worksheet.

Parameter	Type	Description
stringArray	String[]	Formula array.
firstRow	int	The row number of the first cell to import in.
firstColumn	int	The column number of the first cell to import in.
isVertical	boolean	Specifies to import data vertically or horizontally.

textToColumns(row, column, totalRows, options)

Splits the text in the column to columns.

Parameter	Type	Description
row	int	The row index.
column	int	The column index.
totalRows	int	The number of rows.
options	TxtLoadOptions	The split options.

importCSV(fileName, splitter, convertNumericData, firstRow, firstColumn) (1 of 2)

Import a CSV file to the cells.

Parameter	Type	Description
fileName	String	The CSV file name.
splitter	String	The splitter
convertNumericData	boolean	Whether the string in text file is converted to numeric data.
firstRow	int	The row number of the first cell to import in.
firstColumn	int	The column number of the first cell to import in.

importCSV(fileName, options, firstRow, firstColumn) (2 of 2)

Import a CSV file to the cells.

Parameter	Type	Description
fileName	String	The CSV file name.
options	TxtLoadOptions	The load options for reading text file
firstRow	int	The row number of the first cell to import in.
firstColumn	int	The column number of the first cell to import in.

merge(firstRow, firstColumn, totalRows, totalColumns) (1 of 3)

Merges a specified range of cells into a single cell.

Reference the merged cell via the address of the upper-left cell in the range.

Parameter	Type	Description
firstRow	int	First row of this range(zero based)
firstColumn	int	First column of this range(zero based)
totalRows	int	Number of rows(one based)
totalColumns	int	Number of columns(one based)

merge(firstRow, firstColumn, totalRows, totalColumns, mergeConflict) (2 of 3)

Merges a specified range of cells into a single cell.

Reference the merged cell via the address of the upper-left cell in the range. If mergeConflict is true and the merged range conflicts with other merged cells, other merged cells will be automatically removed.

Parameter	Type	Description
firstRow	int	First row of this range(zero based)
firstColumn	int	First column of this range(zero based)
totalRows	int	Number of rows(one based)
totalColumns	int	Number of columns(one based)
mergeConflict	boolean	Merge conflict merged ranges.

merge(firstRow, firstColumn, totalRows, totalColumns, checkConflict, mergeConflict) (3 of 3)

Merges a specified range of cells into a single cell.

Parameter	Type	Description
firstRow	int	First row of this range(zero based)
firstColumn	int	First column of this range(zero based)
totalRows	int	Number of rows(one based)
totalColumns	int	Number of columns(one based)
checkConflict	boolean	Indicates whether check the merged cells intersects other merged cells
mergeConflict	boolean	Merge conflict merged ranges.

unMerge(firstRow, firstColumn, totalRows, totalColumns)

Unmerges a specified range of merged cells.

Parameter	Type	Description
firstRow	int	First row of this range(zero based)
firstColumn	int	First column of this range(zero based)
totalRows	int	Number of rows(one based)
totalColumns	int	Number of columns(one based)

clearMergedCells()

Clears all merged ranges.

hideRow(row)

Hides a row.

Parameter	Type	Description
row	int	Row index.

unhideRow(row, height)

Unhides a row.

Parameter	Type	Description
row	int	Row index.
height	float	Row height. The row’s height will be changed only when the row is hidden and given height value is positive.

hideRows(row, totalRows)

Hides multiple rows.

Parameter	Type	Description
row	int	The row index.
totalRows	int	The row number.

unhideRows(row, totalRows, height)

Unhides the hidden rows.

Parameter	Type	Description
row	int	The row index.
totalRows	int	The row number.
height	float	Row height. The row’s height will be changed only when the row is hidden and given height value is positive.

setRowHeightPixel(row, pixels)

Sets row height in unit of pixels.

Parameter	Type	Description
row	int	Row index.
pixels	int	Number of pixels.

setRowHeightInch(row, inches)

Sets row height in unit of inches.

Parameter	Type	Description
row	int	Row index.
inches	float	Number of inches. It should be between 0 and 409.5/72.

setRowHeight(row, height)

Sets the height of the specified row.

Parameter	Type	Description
row	int	Row index.
height	float	Height of row.In unit of point It should be between 0 and 409.5.

getRowHeight(row, isOriginal, unitType) (1 of 2)

Gets row’s height.

Parameter	Type	Description
row	int	The row index.
isOriginal	boolean	Whether returns the original row height or 0 for hidden row.
unitType	int	A CellsUnitType value. Unit type of the returned height value

Returns: Row’s height

getRowHeight(row) (2 of 2)

Gets the height of a specified row, in unit of points.

Parameter	Type	Description
row	int	Row index

Returns: Height of row

getRowOriginalHeightPoint(row)

Gets original row’s height in unit of point if the row is hidden

NOTE: This member is now obsolete. Instead, please use Cells.GetRowHeight(int,bool,CellsUnitType) method. This method will be removed 12 months later since April 2024. Aspose apologizes for any inconvenience you may have experienced.

Parameter	Type	Description
row	int	The row index.

getColumnOriginalWidthPoint(column)

Gets original column’s height in unit of point if the column is hidden

NOTE: This method is now obsolete. Instead, please use Cells.GetColumnWidth(int ,bool , CellsUnitType ) method. This method will be removed 12 months later since April 2024. Aspose apologizes for any inconvenience you may have experienced.

Parameter	Type	Description
column	int	The row index.

hideColumn(column)

Hides a column.

Parameter	Type	Description
column	int	Column index.

unhideColumn(column, width)

Unhides a column

Parameter	Type	Description
column	int	Column index.
width	float	Column width.

hideColumns(column, totalColumns)

Hide multiple columns.

Parameter	Type	Description
column	int	Column index.
totalColumns	int	Column number.

unhideColumns(column, totalColumns, width)

Unhide multiple columns.

Only applies the column width to the hidden columns.

Parameter	Type	Description
column	int	Column index.
totalColumns	int	Column number
width	float	Column width.

getViewRowHeight(row)

Gets the height of a specified row.

Parameter	Type	Description
row	int	Row index.

Returns: Height of row.

getRowHeightInch(row)

Gets the height of a specified row in unit of inches.

Parameter	Type	Description
row	int	Row index

Returns: Height of row

getViewRowHeightInch(row)

Gets the height of a specified row in unit of inches.

Parameter	Type	Description
row	int	Row index

Returns: Height of row

getRowHeightPixel(row)

Gets the height of a specified row in unit of pixel.

Parameter	Type	Description
row	int	Row index

Returns: Height of row

setColumnWidthPixel(column, pixels)

Sets column width in unit of pixels in normal view.

Parameter	Type	Description
column	int	Column index.
pixels	int	Number of pixels.

setColumnWidthInch(column, inches)

Sets column width in unit of inches in normal view.

Parameter	Type	Description
column	int	Column index.
inches	float	Number of inches.

setColumnWidth(column, width)

Sets the width of the specified column in normal view.

To hide a column, sets column width to zero.

Parameter	Type	Description
column	int	Column index.
width	float	Width of column.Column width must be between 0 and 255.

getColumnWidthPixel(column) (1 of 2)

Gets the width of the specified column in normal view, in units of pixel.

Parameter	Type	Description
column	int	Column index

Returns: Width of column in normal view.

getColumnWidthPixel(column, original) (2 of 2)

Gets the width of the specified column in normal view, in units of pixel.

Parameter	Type	Description
column	int	Column index
original	boolean	Indicates whether returning original width even when the column is hidden

Returns: Width of column in normal view.

getColumnWidthInch(column)

Gets the width of the specified column in normal view, in units of inches.

Parameter	Type	Description
column	int	Column index

Returns: Width of column

importCSVFromBytes(byte_array, firstRow, firstColumn, spliter, convertNumericData) (1 of 2)

Import a CSV file to the cells.

Parameter	Type	Description
byte_array	bytes	The byte array
firstRow	int	The row number of the first cell to import in
firstColumn	int	The column number of the first cell to import in
spliter	String	The spliter
convertNumericData	boolean	Whether the string in text file is converted to numeric data

Example:

import jpype
import asposecells
jpype.startJVM()
from asposecells.api import *

wb = Workbook()
cells = wb.getWorksheets().get(0).getCells()
with open('EmployeeList.csv', 'rb') as f:
    cells.importCSVFromBytes(f.read(), 0, 1, spliter=",", convertNumericData=False)
wb.save("wb.xlsx")

jpype.shutdownJVM()

importCSVFromBytes(byte_array, firstRow, firstColumn, options) (2 of 2)

Import a CSV file to the cells.

Parameter	Type	Description
byte_array	bytes	The byte array
firstRow	int	The row number of the first cell to import in
firstColumn	int	The column number of the first cell to import in
options	TxtLoadOptions	The load options for reading text file

Example:

import jpype
import asposecells
jpype.startJVM()
from asposecells.api import *

wb = Workbook()
cells = wb.getWorksheets().get(0).getCells()
loadOptions = TxtLoadOptions()
with open('EmployeeList.csv', 'rb') as f:
    cells.importCSVFromBytes(f.read(), 0, 1, options=loadOptions)
wb.save("wb.xlsx")

jpype.shutdownJVM()

CellWatchCollection Class CellsColor Class