Methods

importCSVFromStream(cells, stream, spliter, convertNumericData, firstRow, firstColumn, callback)
importCSVFromStream(cells, stream, options, firstRow, firstColumn, callback)
addRange(rangeObject)
applyColumnStyle(column, style, flag)
applyRowStyle(row, style, flag)
applyStyle(style, flag)
checkCell(row, column)
checkColumn(columnIndex)
checkRow(row)
clear()
clearContents(range)
clearContents(startRow, startColumn, endRow, endColumn)
clearFormats(range)
clearFormats(startRow, startColumn, endRow, endColumn)
clearMergedCells()
clearRange(range)
clearRange(startRow, startColumn, endRow, endColumn)
convertStringToNumericValue()
copyColumn(sourceCells, sourceColumnIndex, destinationColumnIndex)
copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber, pasteOptions)
copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber)
copyColumns(sourceCells, sourceColumnIndex, sourceTotalColumns, destinationColumnIndex, destinationTotalColumns)
copyRow(sourceCells, sourceRowIndex, destinationRowIndex)
copyRows(sourceCells, sourceRowIndex, destinationRowIndex, rowNumber)
copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions)
copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions, pasteOptions)
createRange(upperLeftCell, lowerRightCell)
createRange(firstRow, firstColumn, totalRows, totalColumns)
createRange(address)
createRange(firstIndex, number, isVertical)
deleteBlankColumns()
deleteBlankColumns(options)
deleteBlankRows()
deleteBlankRows(options)
deleteColumn(columnIndex, updateReference)
deleteColumn(columnIndex)
deleteColumns(columnIndex, totalColumns, updateReference)
deleteRange(startRow, startColumn, endRow, endColumn, shiftType)
deleteRow(rowIndex)
deleteRows(rowIndex, totalRows)
deleteRows(rowIndex, totalRows, updateReference)
dispose()
endCellInColumn(columnIndex)
endCellInColumn(startRow, endRow, startColumn, endColumn)
endCellInRow(rowIndex)
endCellInRow(startRow, endRow, startColumn, endColumn)
find(what, previousCell)
find(what, previousCell, findOptions)
findFormula(formula, previousCell)
findFormulaContains(formula, previousCell)
get(index)
get(row, column)
get(cellName)
getCell(row, column)
getCellStyle(row, column)
getColumn(columnIndex)
getColumns()
insertColumns(columnIndex, totalColumns)
insertColumns(columnIndex, totalColumns, updateReference)
insertCutCells(cutRange, row, column, shiftType)
insertRange(area, shiftNumber, shiftType, updateReference)
insertRange(area, shiftType)
insertRange(area, shiftNumber, shiftType)
insertRow(rowIndex)
insertRows(rowIndex, totalRows, updateReference)
insertRows(rowIndex, totalRows, options)
insertRows(rowIndex, totalRows)
isBlankColumn(columnIndex)
isColumnHidden(columnIndex)
isDefaultRowHeightMatched()
isDefaultRowHidden()
isDeletingRangeEnabled(startRow, startColumn, totalRows, totalColumns)
isRowHidden(rowIndex)
iterator()
linkToXmlMap(mapName, row, column, path)
merge(firstRow, firstColumn, totalRows, totalColumns)
merge(firstRow, firstColumn, totalRows, totalColumns, mergeConflict)
merge(firstRow, firstColumn, totalRows, totalColumns, checkConflict, mergeConflict)
moveRange(sourceArea, destRow, destColumn)
removeDuplicates()
removeDuplicates(startRow, startColumn, endRow, endColumn)
removeDuplicates(startRow, startColumn, endRow, endColumn, hasHeaders, columnOffsets)
removeFormulas()
retrieveSubtotalSetting(ca)
setColumnWidth(column, width)
setColumnWidthInch(column, inches)
setColumnWidthPixel(column, pixels)
setDefaultRowHeightMatched()
setDefaultRowHidden()
setMemorySetting()
setMultiThreadReading()
setPreserveString()
setRowHeight(row, height)
setRowHeightInch(row, inches)
setRowHeightPixel(row, pixels)
setStandardHeight()
setStandardHeightPixels()
setStandardWidth()
setStandardWidthInch()
setStandardWidthPixels()
setStyle()
setViewColumnWidthPixel(column, pixels)
showGroupDetail(isVertical, index)
subtotal(ca, groupBy, function, totalList)
subtotal(ca, groupBy, function, totalList, replace, pageBreaks, summaryBelowData)
textToColumns(row, column, totalRows, options)
ungroupColumns(firstIndex, lastIndex)
ungroupRows(firstIndex, lastIndex, isAll)
ungroupRows(firstIndex, lastIndex)
unhideColumn(column, width)
unhideColumns(column, totalColumns, width)
unhideRow(row, height)
unhideRows(row, totalRows, height)
unMerge(firstRow, firstColumn, totalRows, totalColumns)

Methods

static

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

Import a CSV file to the cells.

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');
}
);

Parameters

Name Type Optional Description

cells

Cells

 

The Cells object

stream

ReadableStream

 

The CSV file stream

spliter

String

 

The spliter

convertNumericData

boolean

 

Whether the string in text file is converted to numeric data

firstRow

Number

 

The row number of the first cell to import in

firstColumn

Number

 

The column number of the first cell to import in

callback

Callback

 

The callback function

static

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

Import a CSV file to the cells.

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');
}
);

Parameters

Name Type Optional Description

cells

Cells

 

The Cells object

stream

ReadableStream

 

The CSV file stream

options

TxtLoadOptions

 

The load options for reading text file

firstRow

Number

 

The row number of the first cell to import in

firstColumn

Number

 

The column number of the first cell to import in

callback

Callback

 

The callback function

addRange(rangeObject)

Adds a range object reference to cells

Parameter

Name Type Optional Description

rangeObject

Range

 

The range object will be contained in the cells

applyColumnStyle(column, style, flag)

Applies formats for a whole column.

Parameters

Name Type Optional Description

column

Number

 

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.

Parameters

Name Type Optional Description

row

Number

 

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.

Parameters

Name Type Optional Description

style

Style

 

The style object which will be applied.

flag

StyleFlag

 

Flags which indicates applied formatting properties.

checkCell(row, column) → Cell

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

Parameters

Name Type Optional Description

row

Number

 

Row index

column

Number

 

Column index

Returns

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

checkColumn(columnIndex) → Column

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

Parameter

Name Type Optional Description

columnIndex

Number

 

The column index.

Returns

Column The Column object.

checkRow(row) → Row

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

Parameter

Name Type Optional Description

row

Number

 

Row index

Returns

Row If the row object does exist return Row object, otherwise return null.

clear()

Clears all cell and row objects.

clearContents(range)

Clears contents of a range.

Parameter

Name Type Optional Description

range

CellArea

 

Range to be cleared.

clearContents(startRow, startColumn, endRow, endColumn)

Clears contents of a range.

Parameters

Name Type Optional Description

startRow

Number

 

Start row index.

startColumn

Number

 

Start column index.

endRow

Number

 

End row index.

endColumn

Number

 

End column index.

clearFormats(range)

Clears formatting of a range.

Parameter

Name Type Optional Description

range

CellArea

 

Range to be cleared.

clearFormats(startRow, startColumn, endRow, endColumn)

Clears formatting of a range.

Parameters

Name Type Optional Description

startRow

Number

 

Start row index.

startColumn

Number

 

Start column index.

endRow

Number

 

End row index.

endColumn

Number

 

End column index.

clearMergedCells()

Clears all merged ranges.

clearRange(range)

Clears contents and formatting of a range.

Parameter

Name Type Optional Description

range

CellArea

 

Range to be cleared.

clearRange(startRow, startColumn, endRow, endColumn)

Clears contents and formatting of a range.

Parameters

Name Type Optional Description

startRow

Number

 

Start row index.

startColumn

Number

 

Start column index.

endRow

Number

 

End row index.

endColumn

Number

 

End column index.

convertStringToNumericValue()

Converts string data in cells to numeric value if possible.

copyColumn(sourceCells, sourceColumnIndex, destinationColumnIndex)

Copies data and formats of a whole column.

Parameters

Name Type Optional Description

sourceCells

Cells

 

Source Cells object contains data and formats to copy.

sourceColumnIndex

Number

 

Source column index.

destinationColumnIndex

Number

 

Destination column index.

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

Copies data and formats of a whole column.

Parameters

Name Type Optional Description

sourceCells0

Cells

 

Source Cells object contains data and formats to copy.

sourceColumnIndex

Number

 

Source column index.

destinationColumnIndex

Number

 

Destination column index.

columnNumber

Number

 

The copied column number.

pasteOptions

PasteOptions

 

the options of pasting.

copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber)

Copies data and formats of a whole column.

Parameters

Name Type Optional Description

sourceCells0

Cells

 

Source Cells object contains data and formats to copy.

sourceColumnIndex

Number

 

Source column index.

destinationColumnIndex

Number

 

Destination column index.

columnNumber

Number

 

The copied column number.

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

Copies data and formats of the whole columns.

Parameters

Name Type Optional Description

sourceCells

Cells

 

Source Cells object contains data and formats to copy.

sourceColumnIndex

Number

 

Source column index.

sourceTotalColumns

Number

 

The number of the source columns.

destinationColumnIndex

Number

 

Destination column index.

destinationTotalColumns

Number

 

The number of the destination columns.

copyRow(sourceCells, sourceRowIndex, destinationRowIndex)

Copies data and formats of a whole row.

Parameters

Name Type Optional Description

sourceCells

Cells

 

Source Cells object contains data and formats to copy.

sourceRowIndex

Number

 

Source row index.

destinationRowIndex

Number

 

Destination row index.

copyRows(sourceCells, sourceRowIndex, destinationRowIndex, rowNumber)

Copies data and formats of some whole rows.

Parameters

Name Type Optional Description

sourceCells

Cells

 

Source Cells object contains data and formats to copy.

sourceRowIndex

Number

 

Source row index.

destinationRowIndex

Number

 

Destination row index.

rowNumber

Number

 

The copied row number.

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

Copies data and formats of some whole rows.

Parameters

Name Type Optional Description

sourceCells0

Cells

 

Source Cells object contains data and formats to copy.

sourceRowIndex

Number

 

Source row index.

destinationRowIndex

Number

 

Destination row index.

rowNumber

Number

 

The copied row number.

copyOptions

CopyOptions

 

The copy options.

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

Copies data and formats of some whole rows.

Parameters

Name Type Optional Description

sourceCells0

Cells

 

Source Cells object contains data and formats to copy.

sourceRowIndex

Number

 

Source row index.

destinationRowIndex

Number

 

Destination row index.

rowNumber

Number

 

The copied row number.

copyOptions

CopyOptions

 

The copy options.

pasteOptions

PasteOptions

 

the options of pasting.

createRange(upperLeftCell, lowerRightCell) → Range

Creates a Range object from a range of cells.

Parameters

Name Type Optional Description

upperLeftCell

String

 

Upper left cell name.

lowerRightCell

String

 

Lower right cell name.

Returns

Range A Range object

createRange(firstRow, firstColumn, totalRows, totalColumns) → Range

Creates a Range object from a range of cells.

Parameters

Name Type Optional Description

firstRow

Number

 

First row of this range

firstColumn

Number

 

First column of this range

totalRows

Number

 

Number of rows

totalColumns

Number

 

Number of columns

Returns

Range A Range object

createRange(address) → Range

Creates a Range object from an address of the range.

Parameter

Name Type Optional Description

address

String

 

The address of the range.

Returns

Range A Range object

createRange(firstIndex, number, isVertical) → Range

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

Parameters

Name Type Optional Description

firstIndex

Number

 

First row index or first column index, zero based.

number

Number

 

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

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.

Parameter

Name Type Optional Description

options

DeleteOptions

 

The options of deleting range.

deleteBlankRows()

Delete all blank rows which do not contain any data.

deleteBlankRows(options)

Delete all blank rows which do not contain any data.

Parameter

Name Type Optional Description

options

DeleteOptions

 

The options of deleting range.

deleteColumn(columnIndex, updateReference)

Deletes a column.

Parameters

Name Type Optional Description

columnIndex

Number

 

Column index.

updateReference

boolean

 

Indicates if update references in other worksheets.

deleteColumn(columnIndex)

Deletes a column.

Parameter

Name Type Optional Description

columnIndex

Number

 

Column index.

deleteColumns(columnIndex, totalColumns, updateReference)

Deletes several columns.

Parameters

Name Type Optional Description

columnIndex

Number

 

Column index.

totalColumns

Number

 

Number of columns to be deleted.

updateReference

boolean

 

Indicates if update references in other worksheets.

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

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

Parameters

Name Type Optional Description

startRow

Number

 

Start row index.

startColumn

Number

 

Start column index.

endRow

Number

 

End row index.

endColumn

Number

 

End column index.

shiftType

Number

 

ShiftType

deleteRow(rowIndex)

Deletes a row.

Parameter

Name Type Optional Description

rowIndex

Number

 

Row index.

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 as MS Excel.

Parameters

Name Type Optional Description

rowIndex

Number

 

The first row index to be deleted.

totalRows

Number

 

Number of rows to be deleted.

deleteRows(rowIndex, totalRows, updateReference) → boolean

Deletes multiple rows in the worksheet.

Parameters

Name Type Optional Description

rowIndex

Number

 

Row index.

totalRows

Number

 

Number of rows to be deleted.

updateReference

boolean

 

Indicates if update references in other worksheets.

Returns

boolean 

dispose()

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

endCellInColumn(columnIndex) → Cell

Gets the last cell in this column.

Parameter

Name Type Optional Description

columnIndex

Number

 

Column index.

Returns

Cell Cell object.

endCellInColumn(startRow, endRow, startColumn, endColumn) → Cell

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

Parameters

Name Type Optional Description

startRow

Number

 

Start row index.

endRow

Number

 

End row index.

startColumn

Number

 

Start column index.

endColumn

Number

 

End column index.

Returns

Cell Cell object.

endCellInRow(rowIndex) → Cell

Gets the last cell in this row.

Parameter

Name Type Optional Description

rowIndex

Number

 

Row index.

Returns

Cell Cell object.

endCellInRow(startRow, endRow, startColumn, endColumn) → Cell

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

Parameters

Name Type Optional Description

startRow

Number

 

Start row index.

endRow

Number

 

End row index.

startColumn

Number

 

Start column index.

endColumn

Number

 

End column index.

Returns

Cell Cell object.

find(what, previousCell) → Cell

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

Parameters

Name Type Optional 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 Cell object.

find(what, previousCell, findOptions) → Cell

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

Parameters

Name Type Optional 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 Cell object.

findFormula(formula, previousCell) → Cell

Finds the cell with the input string. Returns null (Nothing) if no cell is found. NOTE: This member is now obsolete. Instead, please use Cells.Find(object,Cell,FindOptions) method with LookInType as LookInType.OnlyFormulas and LookAtType as LookAtType.EntireContent. This member will be removed 12 months later since November 2018. Aspose apologizes for any inconvenience you may have experienced.

Parameters

Name Type Optional Description

formula

String

 

The formula to search for.

previousCell

Cell

 

Previous cell with the same formula. This parameter can be set to null if searching from the start.

Returns

Cell Cell object.

findFormulaContains(formula, previousCell) → Cell

Finds the cell with formula which contains the input string. Returns null (Nothing) if no cell is found. NOTE: This member is now obsolete. Instead, please use Cells.Find(object,Cell,FindOptions) method with LookInType as LookInType.OnlyFormulas and LookAtType as LookAtType.Contains. This member will be removed 12 months later since November 2018. Aspose apologizes for any inconvenience you may have experienced.

Parameters

Name Type Optional Description

formula

String

 

The formula to search for.

previousCell

Cell

 

Previous cell with the same formula. This parameter can be set to null if searching from the start.

Returns

Cell Cell object.

get(index)

Gets Cell item within the worksheet The element at the specified index.NOTE: This member is now obsolete. Instead, please use Cells.GetEnumerator() method to iterate all cells in this worksheet. This property will be removed 12 months later since February 2015. Aspose apologizes for any inconvenience you may have experienced.

Parameter

Name Type Optional Description

index

Number

 

The zero based index of the element.

get(row, column) → Cell

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

Example

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

Parameters

Name Type Optional Description

row

Number

 

Row index.

column

Number

 

Column index.

Returns

Cell The Cell object.

get(cellName) → Cell

Gets the Cell element at the specified cell name.

Example

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

Parameter

Name Type Optional Description

cellName

String

 

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

Returns

Cell A Cell object

getCell(row, column) → Cell

Gets the Cell element at the specified cell row index and column index. NOTE: This member is now obsolete. Instead, please use Cells.Get(int,int) method. This method will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

Parameters

Name Type Optional Description

row

Number

 

Row index

column

Number

 

Column index

Returns

Cell Return Cell object.

getCellStyle(row, column) → Style

Get the style of given cell.

Parameters

Name Type Optional Description

row

Number

 

row index

column

Number

 

column

Returns

Style the style of given cell.

getColumn(columnIndex) → Column

Gets the Column element or at the specified cell row index. NOTE: This member is now obsolete. Instead, please use ColumnCollection[int] method. This method will be removed 12 months later since JANUARY 2010. Aspose apologizes for any inconvenience you may have experienced.

Parameter

Name Type Optional Description

columnIndex

Number

 

The column index.

Returns

Column 

getColumns()

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

getColumnWidth(column) → Number

Gets the width of the specified column in normal view

Parameter

Name Type Optional Description

column

Number

 

Column index

Returns

Number Width of column

getColumnWidthInch(column) → Number

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

Parameter

Name Type Optional Description

column

Number

 

Column index

Returns

Number Width of column

getColumnWidthPixel(column) → Number

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

Parameter

Name Type Optional Description

column

Number

 

Column index

Returns

Number Width of column in normal view.

getCount()

Gets the total count of instantiated Cell objects.

getCountLarge()

Gets the total count of instantiated Cell objects.

getDependents(isAll, row, column) → Array of Cell

Get all cells which refer to the specific cell.

Parameters

Name Type Optional Description

isAll

boolean

 

Indicates whether check other worksheets

row

Number

 

The row index.

column

Number

 

The column index.

Returns

Array of Cell 

getFirstCell()

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

getGroupedColumnOutlineLevel(columnIndex) → Number

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

Parameter

Name Type Optional Description

columnIndex

Number

 

The column index

Returns

Number The outline level of the column

getGroupedRowOutlineLevel(rowIndex) → Number

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

Parameter

Name Type Optional Description

rowIndex

Number

 

The row index.

Returns

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) → Number

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

Parameter

Name Type Optional Description

column

Number

 

Column index.

Returns

Number last row index.

getMaxColumn()

Maximum column index of cell which contains data or style. Return -1 if there is no cell.

getMaxDataColumn()

Maximum column index of cell which contains data. Return -1 if there is not cell which contains data. Don't call this property repeatedly. This property will iterate all cells in a worksheet.

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() → Number

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

Returns

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

getMaxGroupedRowOutlineLevel() → Number

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

Returns

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.

getMergedCells()

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

getMinColumn()

Minimum column index of cell which contains data or style.

getMinDataColumn()

Minimum column index of cell which contains data.

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.

getRow(row) → Row

Gets the Row element or at the specified cell row index. NOTE: This member is now obsolete. Instead, please use RowCollection[int] method. This method will be removed 12 months later since JANUARY 2010. Aspose apologizes for any inconvenience you may have experienced.

Parameter

Name Type Optional Description

row

Number

 

Row index

Returns

Row return the row object.

getRowEnumerator() → Iterator

Gets the rows enumerator.

Returns

Iterator The rows enumerator.

getRowHeight(row) → Number

Gets the height of a specified row.

Parameter

Name Type Optional Description

row

Number

 

Row index

Returns

Number Height of row

getRowHeightInch(row) → Number

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

Parameter

Name Type Optional Description

row

Number

 

Row index

Returns

Number Height of row

getRowHeightPixel(row) → Number

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

Parameter

Name Type Optional Description

row

Number

 

Row index

Returns

Number Height of row

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.

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.

getViewColumnWidthPixel(column) → Number

Get the width in different view type.

Parameter

Name Type Optional Description

column

Number

 

The column index.

Returns

Number the column width in unit of pixels

getViewRowHeight(row) → Number

Gets the height of a specified row.

Parameter

Name Type Optional Description

row

Number

 

Row index

Returns

Number Height of row

getViewRowHeightInch(row) → Number

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

Parameter

Name Type Optional Description

row

Number

 

Row index

Returns

Number Height of row

groupColumns(firstIndex, lastIndex)

Groups columns.

Parameters

Name Type Optional Description

firstIndex

Number

 

The first column index to be grouped.

lastIndex

Number

 

The last column index to be grouped.

groupColumns(firstIndex, lastIndex, isHidden)

Groups columns.

Parameters

Name Type Optional Description

firstIndex

Number

 

The first column index to be grouped.

lastIndex

Number

 

The last column index to be grouped.

isHidden

boolean

 

Specifies if the grouped columns are hidden.

groupRows(firstIndex, lastIndex, isHidden)

Groups rows.

Parameters

Name Type Optional Description

firstIndex

Number

 

The first row index to be grouped.

lastIndex

Number

 

The last row index to be grouped.

isHidden

boolean

 

Specifies if the grouped columns are hidden.

groupRows(firstIndex, lastIndex)

Groups rows.

Parameters

Name Type Optional Description

firstIndex

Number

 

The first row index to be grouped.

lastIndex

Number

 

The last row index to be grouped.

hideColumn(column)

Hides a column.

Parameter

Name Type Optional Description

column

Number

 

Column index.

hideColumns(column, totalColumns)

Hide multiple columns.

Parameters

Name Type Optional Description

column

Number

 

Column index.

totalColumns

Number

 

Column number.

hideGroupDetail(isVertical, index)

Collapses the grouped rows/columns.

Parameters

Name Type Optional Description

isVertical

boolean

 

True, collapse the grouped rows.

index

Number

 

The row/column index

hideRow(row)

Hides a row.

Parameter

Name Type Optional Description

row

Number

 

Row index.

hideRows(row, totalRows)

Hides multiple rows.

Parameters

Name Type Optional Description

row

Number

 

The row index.

totalRows

Number

 

The row number.

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

Import a CSV file to the cells.

Parameters

Name Type Optional 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

Number

 

The row number of the first cell to import in.

firstColumn

Number

 

The column number of the first cell to import in.

importCSV(fileName, options, firstRow, firstColumn)

Import a CSV file to the cells.

Parameters

Name Type Optional Description

fileName

String

 

The CSV file name.

options

TxtLoadOptions

 

The load options for reading text file

firstRow

Number

 

The row number of the first cell to import in.

firstColumn

Number

 

The column number of the first cell to import in.

importFormulaArray(stringArray, firstRow, firstColumn, isVertical)

Imports an array of formula into a worksheet.

Parameters

Name Type Optional Description

stringArray

Array of String

 

Formula array.

firstRow

Number

 

The row number of the first cell to import in.

firstColumn

Number

 

The column number of the first cell to import in.

isVertical

boolean

 

Specifies to import data vertically or horizontally.

insertColumn(columnIndex, updateReference)

Inserts a new column into the worksheet.

Parameters

Name Type Optional Description

columnIndex

Number

 

Column index.

updateReference

boolean

 

Indicates if references in other worksheets will be updated.

insertColumn(columnIndex)

Inserts a new column into the worksheet.

Parameter

Name Type Optional Description

columnIndex

Number

 

Column index.

insertColumns(columnIndex, totalColumns)

Inserts some columns into the worksheet.

Parameters

Name Type Optional Description

columnIndex

Number

 

Column index.

totalColumns

Number

 

The number of columns.

insertColumns(columnIndex, totalColumns, updateReference)

Inserts some columns into the worksheet.

Parameters

Name Type Optional Description

columnIndex

Number

 

Column index.

totalColumns

Number

 

The number of columns.

updateReference

boolean

 

Indicates if references in other worksheets will be updated.

insertCutCells(cutRange, row, column, shiftType)

Insert cut range.

Parameters

Name Type Optional Description

cutRange

Range

 

The cut range.

row

Number

 

The row.

column

Number

 

The column.

shiftType

Number

 

ShiftType

insertRange(area, shiftNumber, shiftType, updateReference)

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

Parameters

Name Type Optional Description

area

CellArea

 

Shift area.

shiftNumber

Number

 

Number of rows or columns to be inserted.

shiftType

Number

 

ShiftType

updateReference

boolean

 

Indicates if update references in other worksheets.

insertRange(area, shiftType)

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

Parameters

Name Type Optional Description

area

CellArea

 

Shift area.

shiftType

Number

 

ShiftType

insertRange(area, shiftNumber, shiftType)

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

Parameters

Name Type Optional Description

area

CellArea

 

Shift area.

shiftNumber

Number

 

Number of rows or columns to be inserted.

shiftType

Number

 

ShiftType

insertRow(rowIndex)

Inserts a new row into the worksheet.

Parameter

Name Type Optional Description

rowIndex

Number

 

Row index.

insertRows(rowIndex, totalRows, updateReference)

Inserts multiple rows into the worksheet.

Parameters

Name Type Optional Description

rowIndex

Number

 

Row index.

totalRows

Number

 

Number of rows to be inserted.

updateReference

boolean

 

Indicates if references in other worksheets will be updated.

insertRows(rowIndex, totalRows, options)

Inserts multiple rows into the worksheet.

Parameters

Name Type Optional Description

rowIndex

Number

 

Row index.

totalRows

Number

 

Number of rows to be inserted.

options

InsertOptions

 

Indicates if references in other worksheets will be updated.

insertRows(rowIndex, totalRows)

Inserts multiple rows into the worksheet.

Parameters

Name Type Optional Description

rowIndex

Number

 

Row index.

totalRows

Number

 

Number of rows to be inserted.

isBlankColumn(columnIndex) → boolean

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

Parameter

Name Type Optional Description

columnIndex

Number

 

the column index

Returns

boolean true if given column does not contain any data

isColumnHidden(columnIndex) → boolean

Checks whether a column at given index is hidden.

Parameter

Name Type Optional Description

columnIndex

Number

 

column index

Returns

boolean true if the column is hidden.

isDefaultRowHeightMatched()

Indicates that row height and default font height matches

isDefaultRowHidden()

Indicates whether the row is default hidden.

isDeletingRangeEnabled(startRow, startColumn, totalRows, totalColumns) → boolean

Check whether the range could be deleted.

Parameters

Name Type Optional Description

startRow

Number

 

The start row index of the range.

startColumn

Number

 

The start column index of the range.

totalRows

Number

 

The number of the rows in the range.

totalColumns

Number

 

The number of the columns in the range.

Returns

boolean 

isRowHidden(rowIndex) → boolean

Checks whether a row at given index is hidden.

Parameter

Name Type Optional Description

rowIndex

Number

 

row index

Returns

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"

Parameters

Name Type Optional Description

mapName

String

 

name of xml map

row

Number

 

row of the destination cell

column

Number

 

column of the destination cell

path

String

 

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

Parameters

Name Type Optional Description

firstRow

Number

 

First row of this range(zero based)

firstColumn

Number

 

First column of this range(zero based)

totalRows

Number

 

Number of rows(one based)

totalColumns

Number

 

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

Parameters

Name Type Optional Description

firstRow

Number

 

First row of this range(zero based)

firstColumn

Number

 

First column of this range(zero based)

totalRows

Number

 

Number of rows(one based)

totalColumns

Number

 

Number of columns(one based)

mergeConflict

boolean

 

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

Parameters

Name Type Optional Description

firstRow

Number

 

First row of this range(zero based)

firstColumn

Number

 

First column of this range(zero based)

totalRows

Number

 

Number of rows(one based)

totalColumns

Number

 

Number of columns(one based)

checkConflict

boolean

 

Indicates whether check the merged cells intersects other merged cells

mergeConflict

boolean

 

Merge conflict merged ranges.

moveRange(sourceArea, destRow, destColumn)

Moves the range.

Parameters

Name Type Optional Description

sourceArea

CellArea

 

The range which should be moved.

destRow

Number

 

The dest row.

destColumn

Number

 

The dest column.

removeDuplicates()

Removes duplicate rows in the sheet.

removeDuplicates(startRow, startColumn, endRow, endColumn)

Removes duplicate values in the range.

Parameters

Name Type Optional Description

startRow

Number

 

The start row.

startColumn

Number

 

The start column

endRow

Number

 

The end row index.

endColumn

Number

 

The end column index.

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

Removes duplicate data of the range.

Parameters

Name Type Optional Description

startRow

Number

 

The start row.

startColumn

Number

 

The start column

endRow

Number

 

The end row index.

endColumn

Number

 

The end column index.

hasHeaders

boolean

 

Indicates whether the range contains headers.

columnOffsets

Array of Number

 

The column offsets.

removeFormulas()

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

retrieveSubtotalSetting(ca) → SubtotalSetting

Retrieves subtotals setting of the range.

Parameter

Name Type Optional Description

ca

CellArea

 

The range

Returns

SubtotalSetting 

setColumnWidth(column, width)

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

Parameters

Name Type Optional Description

column

Number

 

Column index.

width

Number

 

Width of column.Column width must be between 0 and 255.

setColumnWidthInch(column, inches)

Sets column width in unit of inches in normal view.

Parameters

Name Type Optional Description

column

Number

 

Column index.

inches

Number

 

Number of inches.

setColumnWidthPixel(column, pixels)

Sets column width in unit of pixels in normal view.

Parameters

Name Type Optional Description

column

Number

 

Column index.

pixels

Number

 

Number of pixels.

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.

Parameters

Name Type Optional Description

row

Number

 

Row index.

height

Number

 

Height of row.In unit of point It should be between 0 and 409.5.

setRowHeightInch(row, inches)

Sets row height in unit of inches.

Parameters

Name Type Optional Description

row

Number

 

Row index.

inches

Number

 

Number of inches. It should be between 0 and 409.5/72.

setRowHeightPixel(row, pixels)

Sets row height in unit of pixels.

Parameters

Name Type Optional Description

row

Number

 

Row index.

pixels

Number

 

Number of pixels.

setStandardHeight()

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

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.

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.

Parameters

Name Type Optional Description

column

Number

 

The column index.

pixels

Number

 

The width in unit of pixels.

showGroupDetail(isVertical, index)

Uncollapses the grouped rows/columns.

Parameters

Name Type Optional Description

isVertical

boolean

 

True, uncollapses the grouped rows.

index

Number

 

The row/column index

subtotal(ca, groupBy, function, totalList)

Creates subtotals for the range.

Parameters

Name Type Optional Description

ca

CellArea

 

The range

groupBy

Number

 

The field to group by, as a zero-based integer offset

function

Number

 

ConsolidationFunction

totalList

Array of Number

 

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

Parameters

Name Type Optional Description

ca

CellArea

 

The range

groupBy

Number

 

The field to group by, as a zero-based integer offset

function

Number

 

ConsolidationFunction

totalList

Array of Number

 

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.

textToColumns(row, column, totalRows, options)

Splits the text in the column to columns.

Parameters

Name Type Optional Description

row

Number

 

The row index.

column

Number

 

The column index.

totalRows

Number

 

The number of rows.

options

TxtLoadOptions

 

The split options.

ungroupColumns(firstIndex, lastIndex)

Ungroups columns.

Parameters

Name Type Optional Description

firstIndex

Number

 

The first column index to be ungrouped.

lastIndex

Number

 

The last column index to be ungrouped.

ungroupRows(firstIndex, lastIndex, isAll)

Ungroups rows.

Parameters

Name Type Optional Description

firstIndex

Number

 

The first row index to be ungrouped.

lastIndex

Number

 

The last row index to be ungrouped.

isAll

boolean

 

True, removes all grouped info.Otherwise, remove the outer group info.

ungroupRows(firstIndex, lastIndex)

Ungroups rows. Only removes outer group info.

Parameters

Name Type Optional Description

firstIndex

Number

 

The first row index to be ungrouped.

lastIndex

Number

 

The last row index to be ungrouped.

unhideColumn(column, width)

Unhides a column

Parameters

Name Type Optional Description

column

Number

 

Column index.

width

Number

 

Column width.

unhideColumns(column, totalColumns, width)

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

Parameters

Name Type Optional Description

column

Number

 

Column index.

totalColumns

Number

 

Column number

width

Number

 

Column width.

unhideRow(row, height)

Unhides a row.

Parameters

Name Type Optional Description

row

Number

 

Row index.

height

Number

 

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

Parameters

Name Type Optional Description

row

Number

 

The row index.

totalRows

Number

 

The row number.

height

Number

 

Row height. The row's height will be changed only when the row is hidden and given height value is positive.

unMerge(firstRow, firstColumn, totalRows, totalColumns)

Unmerges a specified range of merged cells.

Parameters

Name Type Optional Description

firstRow

Number

 

First row of this range(zero based)

firstColumn

Number

 

First column of this range(zero based)

totalRows

Number

 

Number of rows(one based)

totalColumns

Number

 

Number of columns(one based)