Cells

Cells class

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

Methods

NameDescription
addRange(rangeObject)Adds a range object reference to cells
applyColumnStyle(column, style, flag)Applies formats for a whole column.
applyRowStyle(row, style, flag)Applies formats for a whole row.
applyStyle(style, flag)Applies formats for a whole worksheet.
checkCell(row, column)Gets the Cell element or null at the specified cell row index and column index.
checkColumn(columnIndex)Gets the Column element or null at the specified column index.
checkRow(row)Gets the Row element or null at the specified cell row index.
clear()Clears all data of the worksheet.
clearContents(range)Clears contents of a range.
clearContents(startRow, startColumn, endRow, endColumn)Clears contents of a range.
clearFormats(range)Clears formatting of a range.
clearFormats(startRow, startColumn, endRow, endColumn)Clears formatting of a range.
clearMergedCells()Clears all merged ranges.
clearRange(range)Clears contents and formatting of a range.
clearRange(startRow, startColumn, endRow, endColumn)Clears contents and formatting of a range.
convertStringToNumericValue()Converts all string data in the worksheet to numeric value if possible.
copyColumn(sourceCells, sourceColumnIndex, destinationColumnIndex)Copies data and formats of a whole column.
copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber, pasteOptions)Copies data and formats of a whole column.
copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber)Copies data and formats of a whole column.
copyColumns(sourceCells, sourceColumnIndex, sourceTotalColumns, destinationColumnIndex, destinationTotalColumns)Copies data and formats of the whole columns.
copyRow(sourceCells, sourceRowIndex, destinationRowIndex)Copies data and formats of a whole row.
copyRows(sourceCells, sourceRowIndex, destinationRowIndex, rowNumber)Copies data and formats of some whole rows.
copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions)Copies data and formats of some whole rows.
copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions, pasteOptions)Copies data and formats of some whole rows.
createRange(upperLeftCell, lowerRightCell)Creates a Range object from a range of cells.
createRange(firstRow, firstColumn, totalRows, totalColumns)Creates a Range object from a range of cells.
createRange(address)Creates a Range object from an address of the range.
createRange(firstIndex, number, isVertical)Creates a Range object from rows of cells or columns of cells.
deleteBlankColumns()Delete all blank columns which do not contain any data.
deleteBlankColumns(options)Delete all blank columns which do not contain any data.
deleteBlankRows()Delete all blank rows which do not contain any data or other object.
deleteBlankRows(options)Delete all blank rows which do not contain any data or other object. For blank rows that will be deleted, it is not only
deleteColumn(columnIndex, updateReference)Deletes a column.
deleteColumn(columnIndex)Deletes a column.
deleteColumns(columnIndex, totalColumns, updateReference)Deletes several columns.
deleteColumns()
deleteRange(startRow, startColumn, endRow, endColumn, shiftType)Deletes a range of cells and shift cells according to the shift option.
deleteRow(rowIndex)Deletes a row.
deleteRow(rowIndex, updateReference)Deletes a row.
deleteRows(rowIndex, totalRows)Deletes several rows. If the deleted range contains the top part(not whole) of the table(ListObject), the ranged could n
deleteRows(rowIndex, totalRows, updateReference)Deletes multiple rows in the worksheet.
deleteRows()
dispose()Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
endCellInColumn()
endCellInColumn()
endCellInRow(rowIndex)Gets the last cell in this row.
endCellInRow(startRow, endRow, startColumn, endColumn)Gets the last cell with maximum row index in this range.
find(what, previousCell)Finds the cell containing with the input object. Returns null (Nothing) if no cell is found.
find(what, previousCell, findOptions)Finds the cell containing with the input object. Returns null (Nothing) if no cell is found.
get(row, column)Gets the Cell element at the specified cell row index and column index.
get(cellName)Gets the Cell element at the specified cell name.
getCellDisplayStyle()
getCellDisplayStyle()
getCellStyle(row, column)Get the style of given cell.
getCellsWithPlaceInCellPicture()
getColumnOriginalWidthPoint(column)Gets original column’s height in unit of point if the column is hidden Width of column in normal view.NOTE: This method
getColumnWidth(column)Gets the width(in unit of characters) of the specified column in normal view
getColumnWidth(column, isOriginal, unitType)Gets the column width.
getColumnWidthInch(column)Gets the width of the specified column in normal view, in units of inches. Width of column in normal view.NOTE: This met
getColumnWidthPixel(column)Gets the width of the specified column in normal view, in units of pixel.
getColumnWidthPixel(column, original)Gets the width of the specified column in normal view, in units of pixel. NOTE: This method is now obsolete. Instead, pl
getColumns()Gets the collection of Column objects that represents the individual columns in this worksheet.
getCount()Gets the total count of instantiated Cell objects.
getCountLarge()Gets the total count of instantiated Cell objects.
getDependents(isAll, row, column)Get all cells which refer to the specific cell.
getDependentsInCalculation(row, column, recursive)Gets all cells whose calculated result depends on specific cell. To use this method, please make sure the workbook has b
getFirstCell()Gets the first cell in this worksheet. Returns null if there is no data in the worksheet.
getFirstDataRow()
getGroupedColumnOutlineLevel(columnIndex)Gets the outline level (zero-based) of the column. If the column is not grouped, returns zero.
getGroupedRowOutlineLevel(rowIndex)Gets the outline level (zero-based) of the row. If the row is not grouped, returns zero.
getLastCell()Gets the last cell in this worksheet. Returns null if there is no data in the worksheet.
getLastDataRow(column)Gets the last row index of cell which contains data in the specified column.
getMaxColumn()Maximum column index of those cells that have been instantiated in the collection(does not include the column where styl
getMaxDataColumn()Maximum column index of cell which contains data. -1 will be returned if there is no cell which contains data. This prop
getMaxDataRow()Maximum row index of cell which contains data. Return -1 if there is no cell which contains data.
getMaxDisplayRange()Gets the max range which includes data, merged cells and shapes. Reutrns null if the worksheet is empty since Aspose.Cel
getMaxGroupedColumnOutlineLevel()Gets the max grouped column outline level (zero-based).
getMaxGroupedRowOutlineLevel()Gets the max grouped row outline level (zero-based).
getMaxRow()Maximum row index of cell which contains data or style. Return -1 if there is no cell which contains data or style in th
getMemorySetting()Gets or sets the memory usage option for this cells. The value of the property is MemorySetting integer constant.
getMergedAreas()Gets all merged cells.
getMergedCells()Gets the collection of merged cells. In this collection, each item is a CellArea structure which represents an area of m
getMinColumn()Minimum column index of those cells that have been instantiated in the collection(does not include the column where styl
getMinDataColumn()Minimum column index of cell which contains data. -1 will be returned if there is no cell which contains data. This prop
getMinDataRow()Minimum row index of cell which contains data.
getMinRow()Minimum row index of cell which contains data or style.
getMultiThreadReading()Gets or sets whether the cells data model should support Multi-Thread reading. Default value of this property is false.
getOdsCellFields()Gets the list of fields of ods.
getPreserveString()Gets or sets a value indicating whether all worksheet values are preserved as strings. Default is false.
getRanges()Gets the collection of Range objects created at run time.
getRowEnumerator()Gets the rows enumerator. NOTE: This member is now obsolete. Instead, please use RowCollection.GetEnumerator() method. T
getRowHeight(row, isOriginal, unitType)Gets row’s height.
getRowHeight(row)Gets the height of a specified row, in unit of points.
getRowHeightInch(row)Gets the height of a specified row in unit of inches.
getRowHeightPixel(row)Gets the height of a specified row in unit of pixel.
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
getRows()Gets the collection of Row objects that represents the individual rows in this worksheet.
getStandardHeight()Gets or sets the default row height in this worksheet, in unit of points.
getStandardHeightInch()Gets or sets the default row height in this worksheet, in unit of inches.
getStandardHeightPixels()Gets or sets the default row height in this worksheet, in unit of pixels.
getStandardWidth()Gets or sets the default column width in the worksheet, in unit of characters.
getStandardWidthInch()Gets or sets the default column width in the worksheet, in unit of inches.
getStandardWidthPixels()Gets or sets the default column width in the worksheet, in unit of pixels.
getStyle()Gets and sets the default style of the worksheet.
getViewColumnWidthPixel(column)Get the width in different view type.
getViewRowHeight(row)Gets the height of a specified row.
getViewRowHeightInch(row)Gets the height of a specified row in unit of inches.
groupColumns(firstIndex, lastIndex)Groups columns.
groupColumns(firstIndex, lastIndex, isHidden)Groups columns.
groupRows(firstIndex, lastIndex, isHidden)Groups rows.
groupRows(firstIndex, lastIndex)Groups rows.
hideColumn(column)Hides a column.
hideColumns(column, totalColumns)Hide multiple columns.
hideGroupDetail(isVertical, index)Collapses the grouped rows/columns.
hideRow(row)Hides a row.
hideRows(row, totalRows)Hides multiple rows.
importCSV(fileName, splitter, convertNumericData, firstRow, firstColumn)Import a CSV file to the cells.
importCSV(fileName, options, firstRow, firstColumn)Import a CSV file to the cells.
importFormulaArray(stringArray, firstRow, firstColumn, isVertical)Imports an array of formula into a worksheet.
insertColumn(columnIndex, updateReference)Inserts a new column into the worksheet.
insertColumn(columnIndex)Inserts a new column into the worksheet.
insertColumns(columnIndex, totalColumns)Inserts some columns into the worksheet.
insertColumns(columnIndex, totalColumns, updateReference)Inserts some columns into the worksheet.
insertColumns()
insertCutCells(cutRange, row, column, shiftType)Insert cut range.
insertRange(area, shiftNumber, shiftType, updateReference)Inserts a range of cells and shift cells according to the shift option.
insertRange(area, shiftType)Inserts a range of cells and shift cells according to the shift option.
insertRange(area, shiftNumber, shiftType)Inserts a range of cells and shift cells according to the shift option.
insertRow(rowIndex)Inserts a new row into the worksheet.
insertRows(rowIndex, totalRows, updateReference)Inserts multiple rows into the worksheet.
insertRows(rowIndex, totalRows, options)Inserts multiple rows into the worksheet.
insertRows(rowIndex, totalRows)Inserts multiple rows into the worksheet.
isBlankColumn(columnIndex)Checks whether given column is blank(does not contain any data).
isColumnHidden(columnIndex)Checks whether a column at given index is hidden.
isDefaultColumnHidden()
isDefaultRowHeightMatched()Indicates that row height and default font height matches
isDefaultRowHidden()Indicates whether the row is default hidden.
isDeletingRangeEnabled(startRow, startColumn, totalRows, totalColumns)Check whether the range could be deleted.
isRowHidden(rowIndex)Checks whether a row at given index is hidden.
iterator()Gets the cells enumerator. When traversing elements by the returned Enumerator, the cells collection should not be modif
linkToXmlMap(mapName, row, column, path)Link to a xml map. e.g. A xml map element structure: -RootElement |-Attribute1 |-SubElement |-Attribute2 |-Attribute3 To
merge(firstRow, firstColumn, totalRows, totalColumns)Merges a specified range of cells into a single cell. Reference the merged cell via the address of the upper-left cell i
merge(firstRow, firstColumn, totalRows, totalColumns, mergeConflict)Merges a specified range of cells into a single cell. Reference the merged cell via the address of the upper-left cell i
merge(firstRow, firstColumn, totalRows, totalColumns, checkConflict, mergeConflict)Merges a specified range of cells into a single cell. Reference the merged cell via the address of the upper-left cell i
moveRange(sourceArea, destRow, destColumn)Moves the range.
removeDuplicates()Removes duplicate rows in the sheet.
removeDuplicates(startRow, startColumn, endRow, endColumn)Removes duplicate values in the range.
removeDuplicates(startRow, startColumn, endRow, endColumn, hasHeaders, columnOffsets)Removes duplicate data of the range.
removeFormulas()Removes all formula and replaces with the value of the formula.
retrieveSubtotalSetting(ca)Retrieves subtotals setting of the range.
setColumnWidth(column, width)Sets the width of the specified column in normal view. To hide a column, sets column width to zero.
setColumnWidthInch(column, inches)Sets column width in unit of inches in normal view.
setColumnWidthPixel(column, pixels)Sets column width in unit of pixels in normal view.
setDefaultColumnHidden()
setDefaultRowHeightMatched()Indicates that row height and default font height matches
setDefaultRowHidden()Indicates whether the row is default hidden.
setMemorySetting()Gets or sets the memory usage option for this cells. The value of the property is MemorySetting integer constant.
setMultiThreadReading()Gets or sets whether the cells data model should support Multi-Thread reading. Default value of this property is false.
setPreserveString()Gets or sets a value indicating whether all worksheet values are preserved as strings. Default is false.
setRowHeight(row, height)Sets the height of the specified row.
setRowHeightInch(row, inches)Sets row height in unit of inches.
setRowHeightPixel(row, pixels)Sets row height in unit of pixels.
setStandardHeight()Gets or sets the default row height in this worksheet, in unit of points.
setStandardHeightInch()Gets or sets the default row height in this worksheet, in unit of inches.
setStandardHeightPixels()Gets or sets the default row height in this worksheet, in unit of pixels.
setStandardWidth()Gets or sets the default column width in the worksheet, in unit of characters.
setStandardWidthInch()Gets or sets the default column width in the worksheet, in unit of inches.
setStandardWidthPixels()Gets or sets the default column width in the worksheet, in unit of pixels.
setStyle()Gets and sets the default style of the worksheet.
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 widt
showGroupDetail(isVertical, index)Expands the grouped rows/columns.
subtotal(ca, groupBy, function, totalList)Creates subtotals for the range.
subtotal(ca, groupBy, function, totalList, replace, pageBreaks, summaryBelowData)Creates subtotals for the range.
textToColumns(row, column, totalRows, options)Splits the text in the column to columns.
unMerge(firstRow, firstColumn, totalRows, totalColumns)Unmerges a specified range of merged cells.
ungroupColumns(firstIndex, lastIndex)Ungroups columns.
ungroupRows(firstIndex, lastIndex, isAll)Ungroups rows.
ungroupRows(firstIndex, lastIndex)Ungroups rows. Only removes outer group info.
unhideColumn(column, width)Unhides a column
unhideColumns(column, totalColumns, width)Unhide multiple columns. Only applies the column width to the hidden columns.
unhideRow(row, height)Unhides a row.
unhideRows(row, totalRows, height)Unhides the hidden rows.
importCSVFromStream(cells, stream, spliter, convertNumericData, firstRow, firstColumn, callback) (static)Import a CSV file to the cells.
importCSVFromStream(cells, stream, options, firstRow, firstColumn, callback) (static)Import a CSV file to the cells.

addRange(rangeObject)

Adds a range object reference to cells

ParameterTypeDescription
rangeObjectRangeThe range object will be contained in the cells

applyColumnStyle(column, style, flag)

Applies formats for a whole column.

ParameterTypeDescription
columnNumberThe column index.
styleStyleThe style object which will be applied.
flagStyleFlagFlags which indicates applied formatting properties.

applyRowStyle(row, style, flag)

Applies formats for a whole row.

ParameterTypeDescription
rowNumberThe row index.
styleStyleThe style object which will be applied.
flagStyleFlagFlags which indicates applied formatting properties.

applyStyle(style, flag)

Applies formats for a whole worksheet.

ParameterTypeDescription
styleStyleThe style object which will be applied.
flagStyleFlagFlags which indicates applied formatting properties.

checkCell(row, column)

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

ParameterTypeDescription
rowNumberRow index
columnNumberColumn index

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

checkColumn(columnIndex)

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

ParameterTypeDescription
columnIndexNumberThe column index.

Returns: Column — Column The Column object.

checkRow(row)

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

ParameterTypeDescription
rowNumberRow index

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

clear()

Clears all data of the worksheet.

clearContents(range)

Clears contents of a range.

ParameterTypeDescription
rangeCellAreaRange to be cleared.

clearContents(startRow, startColumn, endRow, endColumn)

Clears contents of a range.

ParameterTypeDescription
startRowNumberStart row index.
startColumnNumberStart column index.
endRowNumberEnd row index.
endColumnNumberEnd column index.

clearFormats(range)

Clears formatting of a range.

ParameterTypeDescription
rangeCellAreaRange to be cleared.

clearFormats(startRow, startColumn, endRow, endColumn)

Clears formatting of a range.

ParameterTypeDescription
startRowNumberStart row index.
startColumnNumberStart column index.
endRowNumberEnd row index.
endColumnNumberEnd column index.

clearMergedCells()

Clears all merged ranges.

clearRange(range)

Clears contents and formatting of a range.

ParameterTypeDescription
rangeCellAreaRange to be cleared.

clearRange(startRow, startColumn, endRow, endColumn)

Clears contents and formatting of a range.

ParameterTypeDescription
startRowNumberStart row index.
startColumnNumberStart column index.
endRowNumberEnd row index.
endColumnNumberEnd column index.

convertStringToNumericValue()

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

copyColumn(sourceCells, sourceColumnIndex, destinationColumnIndex)

Copies data and formats of a whole column.

ParameterTypeDescription
sourceCellsCellsSource Cells object contains data and formats to copy.
sourceColumnIndexNumberSource column index.
destinationColumnIndexNumberDestination column index.

copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber, pasteOptions)

Copies data and formats of a whole column.

ParameterTypeDescription
sourceCells0Source Cells object contains data and formats to copy.
sourceColumnIndexNumberSource column index.
destinationColumnIndexNumberDestination column index.
columnNumberNumberThe copied column number.
pasteOptionsPasteOptionsthe options of pasting.

copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber)

Copies data and formats of a whole column.

ParameterTypeDescription
sourceCells0Source Cells object contains data and formats to copy.
sourceColumnIndexNumberSource column index.
destinationColumnIndexNumberDestination column index.
columnNumberNumberThe copied column number.

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

Copies data and formats of the whole columns.

ParameterTypeDescription
sourceCellsCellsSource Cells object contains data and formats to copy.
sourceColumnIndexNumberSource column index.
sourceTotalColumnsNumberThe number of the source columns.
destinationColumnIndexNumberDestination column index.
destinationTotalColumnsNumberThe number of the destination columns.

copyRow(sourceCells, sourceRowIndex, destinationRowIndex)

Copies data and formats of a whole row.

ParameterTypeDescription
sourceCellsCellsSource Cells object contains data and formats to copy.
sourceRowIndexNumberSource row index.
destinationRowIndexNumberDestination row index.

copyRows(sourceCells, sourceRowIndex, destinationRowIndex, rowNumber)

Copies data and formats of some whole rows.

ParameterTypeDescription
sourceCellsCellsSource Cells object contains data and formats to copy.
sourceRowIndexNumberSource row index.
destinationRowIndexNumberDestination row index.
rowNumberNumberThe copied row number.

copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions)

Copies data and formats of some whole rows.

ParameterTypeDescription
sourceCells0Source Cells object contains data and formats to copy.
sourceRowIndexNumberSource row index.
destinationRowIndexNumberDestination row index.
rowNumberNumberThe copied row number.
copyOptionsCopyOptionsThe copy options.

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

Copies data and formats of some whole rows.

ParameterTypeDescription
sourceCells0CellsSource Cells object contains data and formats to copy.
sourceRowIndexNumberSource row index.
destinationRowIndexNumberDestination row index.
rowNumberNumberThe copied row number.
copyOptionsCopyOptionsThe copy options.
pasteOptionsPasteOptionsthe options of pasting.

createRange(upperLeftCell, lowerRightCell)

Creates a Range object from a range of cells.

ParameterTypeDescription
upperLeftCellStringUpper left cell name.
lowerRightCellStringLower right cell name.

Returns: Range — Range A Range object

createRange(firstRow, firstColumn, totalRows, totalColumns)

Creates a Range object from a range of cells.

ParameterTypeDescription
firstRowNumberFirst row of this range
firstColumnNumberFirst column of this range
totalRowsNumberNumber of rows
totalColumnsNumberNumber of columns

Returns: Range — Range A Range object

createRange(address)

Creates a Range object from an address of the range.

ParameterTypeDescription
addressStringThe address of the range.

Returns: Range — Range A Range object

createRange(firstIndex, number, isVertical)

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

ParameterTypeDescription
firstIndexNumberFirst row index or first column index, zero based.
numberNumberTotal number of rows or columns, one based.
isVerticalbooleanTrue - Range created from columns of cells. False - Range created from rows of cells.

Returns: Range — Range A Range object.

deleteBlankColumns()

Delete all blank columns which do not contain any data.

deleteBlankColumns(options)

Delete all blank columns which do not contain any data.

ParameterTypeDescription
optionsDeleteOptionsThe options of deleting range.

deleteBlankRows()

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

deleteBlankRows(options)

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.

ParameterTypeDescription
optionsDeleteOptionsThe options of deleting range.

deleteColumn(columnIndex, updateReference)

Deletes a column.

ParameterTypeDescription
columnIndexNumberIndex of the column to be deleted.
updateReferencebooleanIndicates whether update references in other worksheets.

deleteColumn(columnIndex)

Deletes a column.

ParameterTypeDescription
columnIndexNumberIndex of the column to be deleted.

deleteColumns(columnIndex, totalColumns, updateReference)

Deletes several columns.

ParameterTypeDescription
columnIndexNumberIndex of the first column to be deleted.
totalColumnsNumberCount of columns to be deleted.
updateReferencebooleanIndicates whether update references in other worksheets.

deleteColumns()

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

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

ParameterTypeDescription
startRowNumberStart row index.
startColumnNumberStart column index.
endRowNumberEnd row index.
endColumnNumberEnd column index.
shiftTypeNumberShiftType

deleteRow(rowIndex)

Deletes a row.

ParameterTypeDescription
rowIndexNumberIndex of the row to be deleted.

deleteRow(rowIndex, updateReference)

Deletes a row.

ParameterTypeDescription
rowIndexNumberIndex of the row to be deleted.
updateReferencebooleanIndicates whether update references in other worksheets.

deleteRows(rowIndex, totalRows)

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.

ParameterTypeDescription
rowIndexNumberThe first row index to be deleted.
totalRowsNumberCount of rows to be deleted.

deleteRows(rowIndex, totalRows, updateReference)

Deletes multiple rows in the worksheet.

ParameterTypeDescription
rowIndexNumberIndex of the first row to be deleted.
totalRowsNumberCount of rows to be deleted.
updateReferencebooleanIndicates whether update references in other worksheets.

Returns: boolean — boolean

deleteRows()

dispose()

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

endCellInColumn()

endCellInColumn()

endCellInRow(rowIndex)

Gets the last cell in this row.

ParameterTypeDescription
rowIndexNumberRow index.

Returns: Cell — Cell Cell object.

endCellInRow(startRow, endRow, startColumn, endColumn)

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

ParameterTypeDescription
startRowNumberStart row index.
endRowNumberEnd row index.
startColumnNumberStart column index.
endColumnNumberEnd column index.

Returns: Cell — Cell Cell object.

find(what, previousCell)

Finds the cell containing with the input object. Returns null (Nothing) if no cell is found.

ParameterTypeDescription
whatObjectThe object to search for. The type should be int,double,DateTime,string,bool.
previousCellCellPrevious cell with the same object. This parameter can be set to null if searching from the start.

Returns: Cell — Cell Cell object.

find(what, previousCell, findOptions)

Finds the cell containing with the input object. Returns null (Nothing) if no cell is found.

ParameterTypeDescription
whatObjectThe object to search for. The type should be int,double,DateTime,string,bool.
previousCellCellPrevious cell with the same object. This parameter can be set to null if searching from the start.
findOptionsFindOptionsFind options

Returns: Cell — Cell Cell object.

get(row, column)

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

ParameterTypeDescription
rowNumberRow index.
columnNumberColumn index.

Returns: Cell — Cell The Cell object.

Example:

var cells = excel.getWorksheets().get(0).getCells();
var cell = cells.get(0, 0);    //Gets the cell at "A1"

get(cellName)

Gets the Cell element at the specified cell name.

ParameterTypeDescription
cellNameStringCell name,including its column letter and row number, for example A5.

Returns: Cell — Cell A Cell object

Example:

var cells = excel.getWorksheets().get(0).getCells();
var cell = cells.get("A1");    //Gets the cell at "A1"

getCellDisplayStyle()

getCellDisplayStyle()

getCellStyle(row, column)

Get the style of given cell.

ParameterTypeDescription
rowNumberrow index
columnNumbercolumn

Returns: Style — Style the style of given cell.

getCellsWithPlaceInCellPicture()

getColumnOriginalWidthPoint(column)

Gets original column’s height in unit of point if the column is hidden Width of column in normal view.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.

ParameterTypeDescription
columnNumberThe row index.

Returns: Number — Number

getColumnWidth(column)

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

ParameterTypeDescription
columnNumberColumn index

Returns: Number — Number 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)

Gets the column width.

ParameterTypeDescription
columnNumberThe column index.
isOriginalbooleanIndicates whether getting original width.
unitTypeNumberCellsUnitType

Returns: Number — Number

getColumnWidthInch(column)

Gets the width of the specified column in normal view, in units of inches. Width of column in normal view.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.

ParameterTypeDescription
columnNumberColumn index

Returns: Number — Number Width of column

getColumnWidthPixel(column)

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

ParameterTypeDescription
columnNumberColumn index

Returns: Number — Number Width of column in normal view.

getColumnWidthPixel(column, original)

Gets the width of the specified column in normal view, in units of pixel. 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.

ParameterTypeDescription
columnNumberColumn index
originalbooleanIndicates whether returning original width even when the column is hidden

Returns: Number — Number Width of column in normal view.

getColumns()

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

getCount()

Gets the total count of instantiated Cell objects.

getCountLarge()

Gets the total count of instantiated Cell objects.

getDependents(isAll, row, column)

Get all cells which refer to the specific cell.

ParameterTypeDescription
isAllbooleanIndicates whether check other worksheets
rowNumberThe row index.
columnNumberThe column index.

Returns: Array ofCell — Array ofCell

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)

ParameterTypeDescription
rowNumberRow index of the specific cell
columnNumberColumn index of the specific cell.
recursivebooleanWhether returns those dependents which do not reference to the specific cell directly but reference to other leafs of that cell.

Returns: Iterator — Iterator Enumerator to enumerate all dependents(Cell objects)

getFirstCell()

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

getFirstDataRow()

getGroupedColumnOutlineLevel(columnIndex)

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

ParameterTypeDescription
columnIndexNumberThe column index

Returns: Number — Number The outline level of the column

getGroupedRowOutlineLevel(rowIndex)

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

ParameterTypeDescription
rowIndexNumberThe row index.

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

getLastCell()

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

getLastDataRow(column)

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

ParameterTypeDescription
columnNumberColumn index.

Returns: Number — Number last row index.

getMaxColumn()

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.

getMaxDataColumn()

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.

getMaxDataRow()

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

getMaxDisplayRange()

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

getMaxGroupedColumnOutlineLevel()

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

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

getMaxGroupedRowOutlineLevel()

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

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

getMaxRow()

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.

getMemorySetting()

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

getMergedAreas()

Gets all merged cells.

getMergedCells()

Gets the collection of merged cells. In this collection, each item is a CellArea structure which represents an area of merged cells. NOTE: This method is now obsolete. Instead, please use Cells.GetMergedAreas() method. This method will be removed 12 months later since November 2023. Aspose apologizes for any inconvenience you may have experienced.

getMinColumn()

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).

getMinDataColumn()

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.

getMinDataRow()

Minimum row index of cell which contains data.

getMinRow()

Minimum row index of cell which contains data or style.

getMultiThreadReading()

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.

getOdsCellFields()

Gets the list of fields of ods.

getPreserveString()

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

getRanges()

Gets the collection of Range objects created at run time.

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.@return {Iterator} The rows enumerator.See Also:RowCollection.iterator()

getRowHeight(row, isOriginal, unitType)

Gets row’s height.

ParameterTypeDescription
rowNumberThe row index.
isOriginalbooleanWhether returns the original row height or 0 for hidden row.
unitTypeNumberCellsUnitType

Returns: Number — Number Row’s height

getRowHeight(row)

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

ParameterTypeDescription
rowNumberRow index

Returns: Number — Number Height of row

getRowHeightInch(row)

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

ParameterTypeDescription
rowNumberRow index

Returns: Number — Number Height of row

getRowHeightPixel(row)

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

ParameterTypeDescription
rowNumberRow index

Returns: Number — Number 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.

ParameterTypeDescription
rowNumberThe row index.

Returns: Number — Number

getRows()

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

getStandardHeight()

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

getStandardHeightInch()

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

getStandardHeightPixels()

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

getStandardWidth()

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

getStandardWidthInch()

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

getStandardWidthPixels()

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

getStyle()

Gets and sets the default style of the worksheet.

getViewColumnWidthPixel(column)

Get the width in different view type.

ParameterTypeDescription
columnNumberThe column index.

Returns: Number — Number the column width in unit of pixels

getViewRowHeight(row)

Gets the height of a specified row.

ParameterTypeDescription
rowNumberRow index.

Returns: Number — Number Height of row.

getViewRowHeightInch(row)

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

ParameterTypeDescription
rowNumberRow index

Returns: Number — Number Height of row

groupColumns(firstIndex, lastIndex)

Groups columns.

ParameterTypeDescription
firstIndexNumberThe first column index to be grouped.
lastIndexNumberThe last column index to be grouped.

groupColumns(firstIndex, lastIndex, isHidden)

Groups columns.

ParameterTypeDescription
firstIndexNumberThe first column index to be grouped.
lastIndexNumberThe last column index to be grouped.
isHiddenbooleanSpecifies if the grouped columns are hidden.

groupRows(firstIndex, lastIndex, isHidden)

Groups rows.

ParameterTypeDescription
firstIndexNumberThe first row index to be grouped.
lastIndexNumberThe last row index to be grouped.
isHiddenbooleanSpecifies if the grouped rows are hidden.

groupRows(firstIndex, lastIndex)

Groups rows.

ParameterTypeDescription
firstIndexNumberThe first row index to be grouped.
lastIndexNumberThe last row index to be grouped.

hideColumn(column)

Hides a column.

ParameterTypeDescription
columnNumberColumn index.

hideColumns(column, totalColumns)

Hide multiple columns.

ParameterTypeDescription
columnNumberColumn index.
totalColumnsNumberColumn number.

hideGroupDetail(isVertical, index)

Collapses the grouped rows/columns.

ParameterTypeDescription
isVerticalbooleanTrue, collapse the grouped rows.
indexNumberThe row/column index

hideRow(row)

Hides a row.

ParameterTypeDescription
rowNumberRow index.

hideRows(row, totalRows)

Hides multiple rows.

ParameterTypeDescription
rowNumberThe row index.
totalRowsNumberThe row number.

importCSV(fileName, splitter, convertNumericData, firstRow, firstColumn)

Import a CSV file to the cells.

ParameterTypeDescription
fileNameStringThe CSV file name.
splitterStringThe splitter
convertNumericDatabooleanWhether the string in text file is converted to numeric data.
firstRowNumberThe row number of the first cell to import in.
firstColumnNumberThe column number of the first cell to import in.

importCSV(fileName, options, firstRow, firstColumn)

Import a CSV file to the cells.

ParameterTypeDescription
fileNameStringThe CSV file name.
optionsTxtLoadOptionsThe load options for reading text file
firstRowNumberThe row number of the first cell to import in.
firstColumnNumberThe column number of the first cell to import in.

importFormulaArray(stringArray, firstRow, firstColumn, isVertical)

Imports an array of formula into a worksheet.

ParameterTypeDescription
stringArrayArray of StringFormula array.
firstRowNumberThe row number of the first cell to import in.
firstColumnNumberThe column number of the first cell to import in.
isVerticalbooleanSpecifies to import data vertically or horizontally.

insertColumn(columnIndex, updateReference)

Inserts a new column into the worksheet.

ParameterTypeDescription
columnIndexNumberColumn index.
updateReferencebooleanIndicates if references in other worksheets will be updated.

insertColumn(columnIndex)

Inserts a new column into the worksheet.

ParameterTypeDescription
columnIndexNumberColumn index.

insertColumns(columnIndex, totalColumns)

Inserts some columns into the worksheet.

ParameterTypeDescription
columnIndexNumberColumn index.
totalColumnsNumberThe number of columns.

insertColumns(columnIndex, totalColumns, updateReference)

Inserts some columns into the worksheet.

ParameterTypeDescription
columnIndexNumberColumn index.
totalColumnsNumberThe number of columns.
updateReferencebooleanIndicates if references in other worksheets will be updated.

insertColumns()

insertCutCells(cutRange, row, column, shiftType)

Insert cut range.

ParameterTypeDescription
cutRangeRangeThe cut range.
rowNumberThe row.
columnNumberThe column.
shiftTypeNumberShiftType

insertRange(area, shiftNumber, shiftType, updateReference)

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

ParameterTypeDescription
areaCellAreaShift area.
shiftNumberNumberNumber of rows or columns to be inserted.
shiftTypeNumberShiftType
updateReferencebooleanIndicates whether update references in other worksheets.

insertRange(area, shiftType)

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

ParameterTypeDescription
areaCellAreaShift area.
shiftTypeNumberShiftType

insertRange(area, shiftNumber, shiftType)

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

ParameterTypeDescription
areaCellAreaShift area.
shiftNumberNumberNumber of rows or columns to be inserted.
shiftTypeNumberShiftType

insertRow(rowIndex)

Inserts a new row into the worksheet.

ParameterTypeDescription
rowIndexNumberRow index.

insertRows(rowIndex, totalRows, updateReference)

Inserts multiple rows into the worksheet.

ParameterTypeDescription
rowIndexNumberRow index.
totalRowsNumberNumber of rows to be inserted.
updateReferencebooleanIndicates if references in other worksheets will be updated.

insertRows(rowIndex, totalRows, options)

Inserts multiple rows into the worksheet.

ParameterTypeDescription
rowIndexNumberRow index.
totalRowsNumberNumber of rows to be inserted.
optionsInsertOptionsIndicates if references in other worksheets will be updated.

insertRows(rowIndex, totalRows)

Inserts multiple rows into the worksheet.

ParameterTypeDescription
rowIndexNumberRow index.
totalRowsNumberNumber of rows to be inserted.

isBlankColumn(columnIndex)

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

ParameterTypeDescription
columnIndexNumberthe column index

Returns: boolean — boolean true if given column does not contain any data

isColumnHidden(columnIndex)

Checks whether a column at given index is hidden.

ParameterTypeDescription
columnIndexNumbercolumn index

Returns: boolean — boolean true if the column is hidden.

isDefaultColumnHidden()

isDefaultRowHeightMatched()

Indicates that row height and default font height matches

isDefaultRowHidden()

Indicates whether the row is default hidden.

isDeletingRangeEnabled(startRow, startColumn, totalRows, totalColumns)

Check whether the range could be deleted.

ParameterTypeDescription
startRowNumberThe start row index of the range.
startColumnNumberThe start column index of the range.
totalRowsNumberThe number of the rows in the range.
totalColumnsNumberThe number of the columns in the range.

Returns: boolean — boolean

isRowHidden(rowIndex)

Checks whether a row at given index is hidden.

ParameterTypeDescription
rowIndexNumberrow index

Returns: boolean — boolean true if the row is hidden

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).@return {Iterator} The cells enumerator

linkToXmlMap(mapName, row, column, path)

Link to a xml map. e.g. A xml map element structure: -RootElement |-Attribute1 |-SubElement |-Attribute2 |-Attribute3 To link “Attribute1”, path is “/RootElement/Attribute1” To link “Attribute2”, path is “/RootElement/SubElement/Attribute2” To link whole “SubElement”, path is “/RootElement/SubElement”

ParameterTypeDescription
mapNameStringname of xml map
rowNumberrow of the destination cell
columnNumbercolumn of the destination cell
pathStringpath of xml element in xml map

merge(firstRow, firstColumn, totalRows, totalColumns)

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.

ParameterTypeDescription
firstRowNumberFirst row of this range(zero based)
firstColumnNumberFirst column of this range(zero based)
totalRowsNumberNumber of rows(one based)
totalColumnsNumberNumber of columns(one based)

merge(firstRow, firstColumn, totalRows, totalColumns, mergeConflict)

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.

ParameterTypeDescription
firstRowNumberFirst row of this range(zero based)
firstColumnNumberFirst column of this range(zero based)
totalRowsNumberNumber of rows(one based)
totalColumnsNumberNumber of columns(one based)
mergeConflictbooleanMerge conflict merged ranges.

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

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.

ParameterTypeDescription
firstRowNumberFirst row of this range(zero based)
firstColumnNumberFirst column of this range(zero based)
totalRowsNumberNumber of rows(one based)
totalColumnsNumberNumber of columns(one based)
checkConflictbooleanIndicates whether check the merged cells intersects other merged cells
mergeConflictbooleanMerge conflict merged ranges.

moveRange(sourceArea, destRow, destColumn)

Moves the range.

ParameterTypeDescription
sourceAreaCellAreaThe range which should be moved.
destRowNumberThe dest row.
destColumnNumberThe dest column.

removeDuplicates()

Removes duplicate rows in the sheet.

removeDuplicates(startRow, startColumn, endRow, endColumn)

Removes duplicate values in the range.

ParameterTypeDescription
startRowNumberThe start row.
startColumnNumberThe start column
endRowNumberThe end row index.
endColumnNumberThe end column index.

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

Removes duplicate data of the range.

ParameterTypeDescription
startRowNumberThe start row.
startColumnNumberThe start column
endRowNumberThe end row index.
endColumnNumberThe end column index.
hasHeadersbooleanIndicates whether the range contains headers.
columnOffsetsArray of NumberThe column offsets.

removeFormulas()

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

retrieveSubtotalSetting(ca)

Retrieves subtotals setting of the range.

ParameterTypeDescription
caCellAreaThe range

Returns: SubtotalSetting — SubtotalSetting

setColumnWidth(column, width)

Sets the width of the specified column in normal view. To hide a column, sets column width to zero.

ParameterTypeDescription
columnNumberColumn index.
widthNumberWidth of column.Column width must be between 0 and 255.

setColumnWidthInch(column, inches)

Sets column width in unit of inches in normal view.

ParameterTypeDescription
columnNumberColumn index.
inchesNumberNumber of inches.

setColumnWidthPixel(column, pixels)

Sets column width in unit of pixels in normal view.

ParameterTypeDescription
columnNumberColumn index.
pixelsNumberNumber of pixels.

setDefaultColumnHidden()

setDefaultRowHeightMatched()

Indicates that row height and default font height matches

setDefaultRowHidden()

Indicates whether the row is default hidden.

setMemorySetting()

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

setMultiThreadReading()

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.

setPreserveString()

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

setRowHeight(row, height)

Sets the height of the specified row.

ParameterTypeDescription
rowNumberRow index.
heightNumberHeight of row.In unit of point It should be between 0 and 409.5.

setRowHeightInch(row, inches)

Sets row height in unit of inches.

ParameterTypeDescription
rowNumberRow index.
inchesNumberNumber of inches. It should be between 0 and 409.5/72.

setRowHeightPixel(row, pixels)

Sets row height in unit of pixels.

ParameterTypeDescription
rowNumberRow index.
pixelsNumberNumber of pixels.

setStandardHeight()

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

setStandardHeightInch()

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

setStandardHeightPixels()

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

setStandardWidth()

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

setStandardWidthInch()

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

setStandardWidthPixels()

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

setStyle()

Gets and sets the default style of the worksheet.

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.

ParameterTypeDescription
columnNumberThe column index.
pixelsNumberThe width in unit of pixels.

showGroupDetail(isVertical, index)

Expands the grouped rows/columns.

ParameterTypeDescription
isVerticalbooleanTrue, expands the grouped rows.
indexNumberThe row/column index

subtotal(ca, groupBy, function, totalList)

Creates subtotals for the range.

ParameterTypeDescription
caCellAreaThe range
groupByNumberThe field to group by, as a zero-based integer offset
functionNumberConsolidationFunction
totalListArray of NumberAn array of zero-based field offsets, indicating the fields to which the subtotals are added.

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

Creates subtotals for the range.

ParameterTypeDescription
caCellAreaThe range
groupByNumberThe field to group by, as a zero-based integer offset
functionNumberConsolidationFunction
totalListArray of NumberAn array of zero-based field offsets, indicating the fields to which the subtotals are added.
replacebooleanIndicates whether replace the current subtotals
pageBreaksbooleanIndicates whether add page break between groups
summaryBelowDatabooleanIndicates whether add summary below data.

textToColumns(row, column, totalRows, options)

Splits the text in the column to columns.

ParameterTypeDescription
rowNumberThe row index.
columnNumberThe column index.
totalRowsNumberThe number of rows.
optionsTxtLoadOptionsThe split options.

unMerge(firstRow, firstColumn, totalRows, totalColumns)

Unmerges a specified range of merged cells.

ParameterTypeDescription
firstRowNumberFirst row of this range(zero based)
firstColumnNumberFirst column of this range(zero based)
totalRowsNumberNumber of rows(one based)
totalColumnsNumberNumber of columns(one based)

ungroupColumns(firstIndex, lastIndex)

Ungroups columns.

ParameterTypeDescription
firstIndexNumberThe first column index to be ungrouped.
lastIndexNumberThe last column index to be ungrouped.

ungroupRows(firstIndex, lastIndex, isAll)

Ungroups rows.

ParameterTypeDescription
firstIndexNumberThe first row index to be ungrouped.
lastIndexNumberThe last row index to be ungrouped.
isAllbooleanTrue, removes all grouped info.Otherwise, remove the outer group info.

ungroupRows(firstIndex, lastIndex)

Ungroups rows. Only removes outer group info.

ParameterTypeDescription
firstIndexNumberThe first row index to be ungrouped.
lastIndexNumberThe last row index to be ungrouped.

unhideColumn(column, width)

Unhides a column

ParameterTypeDescription
columnNumberColumn index.
widthNumberColumn width.

unhideColumns(column, totalColumns, width)

Unhide multiple columns. Only applies the column width to the hidden columns.

ParameterTypeDescription
columnNumberColumn index.
totalColumnsNumberColumn number
widthNumberColumn width.

unhideRow(row, height)

Unhides a row.

ParameterTypeDescription
rowNumberRow index.
heightNumberRow height. The row’s height will be changed only when the row is hidden and given height value is positive.

unhideRows(row, totalRows, height)

Unhides the hidden rows.

ParameterTypeDescription
rowNumberThe row index.
totalRowsNumberThe row number.
heightNumberRow height. The row’s height will be changed only when the row is hidden and given height value is positive.

importCSVFromStream(cells, stream, spliter, convertNumericData, firstRow, firstColumn, callback) (static)

Import a CSV file to the cells.

ParameterTypeDescription
cellsCellsThe Cells object
streamReadableStreamThe CSV file stream
spliterStringThe spliter
convertNumericDatabooleanWhether the string in text file is converted to numeric data
firstRowNumberThe row number of the first cell to import in
firstColumnNumberThe column number of the first cell to import in
callbackCallbackThe callback function

Example:

var aspose = aspose || {};
aspose.cells = require("aspose.cells");
var fs = require("fs");
var workbook = new aspose.cells.Workbook();
var cells = workbook.getWorksheets().get(0).getCells();
var readStream = fs.createReadStream("EmployeeList.csv");
aspose.cells.Cells.importCSVFromStream(cells, readStream, ",", false, 0, 1,
function(err) {
workbook.save('result.xlsx');
}
);

importCSVFromStream(cells, stream, options, firstRow, firstColumn, callback) (static)

Import a CSV file to the cells.

ParameterTypeDescription
cellsCellsThe Cells object
streamReadableStreamThe CSV file stream
optionsTxtLoadOptionsThe load options for reading text file
firstRowNumberThe row number of the first cell to import in
firstColumnNumberThe column number of the first cell to import in
callbackCallbackThe callback function

Example:

var aspose = aspose || {};
aspose.cells = require("aspose.cells");
var fs = require("fs");
var workbook = new aspose.cells.Workbook();
var cells = workbook.getWorksheets().get(0).getCells();
var loadOptions = new aspose.cells.TxtLoadOptions();
var readStream = fs.createReadStream("EmployeeList.csv");
aspose.cells.Cells.importCSVFromStream(cells, readStream, loadOptions, 0, 1,
function(err) {
workbook.save('result.xlsx');
}
);