asposecells.api

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

Example:

excel = Workbook()
cells = excel.getWorksheets().get(0).getCells()
# Set default row height
cells.setStandardHeight(20)
# Set row height
cells.setRowHeight(2, 20.5)
# Set default colum width
cells.setStandardWidth(15)
# Set column width
cells.setColumnWidth(3, 12.57)
# Merge cells
cells.merge(5, 4, 2, 2)

Property Getters/Setters Summary
methodgetColumns()
Gets the collection of Column objects that represents the individual columns in this worksheet.
methodgetCount()
Gets the total count of instantiated Cell objects.
methodgetCountLarge()
Gets the total count of instantiated Cell objects.
methodgetFirstCell()
Gets the first cell in this worksheet.
methodisDefaultRowHeightMatched()
method
           Indicates that row height and default font height matches
methodisDefaultRowHidden()
method
           Indicates whether the row is default hidden.
methodgetLastCell()
Gets the last cell in this worksheet.
methodgetMaxColumn()
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).
methodgetMaxDataColumn()
Maximum column index of cell which contains data.
methodgetMaxDataRow()
Maximum row index of cell which contains data.
methodgetMaxDisplayRange()
Gets the max range which includes data, merged cells and shapes.
methodgetMaxRow()
Maximum row index of cell which contains data or style.
methodgetMemorySetting()
method
           Gets or sets the memory usage option for this cells. The value of the property is MemorySetting integer constant.
methodgetMergedCells()
Gets the collection of merged cells.
methodgetMinColumn()
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).
methodgetMinDataColumn()
Minimum column index of cell which contains data.
methodgetMinDataRow()
Minimum row index of cell which contains data.
methodgetMinRow()
Minimum row index of cell which contains data or style.
methodgetMultiThreadReading()
method
           Gets or sets whether the cells data model should support Multi-Thread reading. Default value of this property is false.
methodgetOdsCellFields()
Gets the list of fields of ods.
methodgetPreserveString()
method
           Gets or sets a value indicating whether all worksheet values are preserved as strings. Default is false.
methodgetRanges()
Gets the collection of Range objects created at run time.
methodgetRows()
Gets the collection of Row objects that represents the individual rows in this worksheet.
methodgetStandardHeight()
method
           Gets or sets the default row height in this worksheet, in unit of points.
methodgetStandardHeightInch()
method
           Gets or sets the default row height in this worksheet, in unit of inches.
methodgetStandardHeightPixels()
method
           Gets or sets the default row height in this worksheet, in unit of pixels.
methodgetStandardWidth()
method
           Gets or sets the default column width in the worksheet, in unit of characters.
methodgetStandardWidthInch()
method
           Gets or sets the default column width in the worksheet, in unit of inches.
methodgetStandardWidthPixels()
method
           Gets or sets the default column width in the worksheet, in unit of pixels.
methodgetStyle()
method
setStyle(value)
           Gets and sets the default style of the worksheet.
methodget(row, column)
Gets the Cell element at the specified cell row index and column index.
methodget(cellName)
Gets the Cell element at the specified cell name.
 
Method Summary
methodaddRange(rangeObject)
Adds a range object reference to cells
methodapplyColumnStyle(column, style, flag)
Applies formats for a whole column.
methodapplyRowStyle(row, style, flag)
Applies formats for a whole row.
methodapplyStyle(style, flag)
Applies formats for a whole worksheet.
methodcheckCell(row, column)
Gets the Cell element or null at the specified cell row index and column index.
methodcheckColumn(columnIndex)
Gets the Column element or null at the specified column index.
methodcheckRow(row)
Gets the Row element or null at the specified cell row index.
methodclear()
Clears all data of the worksheet.
methodclearContents(range)
Clears contents of a range.
methodclearContents(startRow, startColumn, endRow, endColumn)
Clears contents of a range.
methodclearFormats(range)
Clears formatting of a range.
methodclearFormats(startRow, startColumn, endRow, endColumn)
Clears formatting of a range.
methodclearMergedCells()
Clears all merged ranges.
methodclearRange(range)
Clears contents and formatting of a range.
methodclearRange(startRow, startColumn, endRow, endColumn)
Clears contents and formatting of a range.
methodconvertStringToNumericValue()
Converts all string data in the worksheet to numeric value if possible.
methodcopyColumn(sourceCells, sourceColumnIndex, destinationColumnIndex)
Copies data and formats of a whole column.
methodcopyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber)
Copies data and formats of a whole column.
methodcopyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber, pasteOptions)
Copies data and formats of a whole column.
methodcopyColumns(sourceCells, sourceColumnIndex, sourceTotalColumns, destinationColumnIndex, destinationTotalColumns)
Copies data and formats of the whole columns.
methodcopyRow(sourceCells, sourceRowIndex, destinationRowIndex)
Copies data and formats of a whole row.
methodcopyRows(sourceCells, sourceRowIndex, destinationRowIndex, rowNumber)
Copies data and formats of some whole rows.
methodcopyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions)
Copies data and formats of some whole rows.
methodcopyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions, pasteOptions)
Copies data and formats of some whole rows.
methodcreateRange(firstIndex, number, isVertical)
Creates a Range object from rows of cells or columns of cells.
methodcreateRange(firstRow, firstColumn, totalRows, totalColumns)
Creates a Range object from a range of cells.
methodcreateRange(address)
Creates a Range object from an address of the range.
methodcreateRange(upperLeftCell, lowerRightCell)
Creates a Range object from a range of cells.
methoddeleteBlankColumns()
Delete all blank columns which do not contain any data.
methoddeleteBlankColumns(options)
Delete all blank columns which do not contain any data.
methoddeleteBlankRows()
Delete all blank rows which do not contain any data or other object.
methoddeleteBlankRows(options)
Delete all blank rows which do not contain any data or other object.
methoddeleteColumn(columnIndex)
Deletes a column.
methoddeleteColumn(columnIndex, updateReference)
Deletes a column.
methoddeleteColumns(columnIndex, totalColumns, updateReference)
Deletes several columns.
methoddeleteRange(startRow, startColumn, endRow, endColumn, shiftType)
Deletes a range of cells and shift cells according to the shift option.
methoddeleteRow(rowIndex)
Deletes a row.
methoddeleteRow(rowIndex, updateReference)
Deletes a row.
methoddeleteRows(rowIndex, totalRows)
Deletes several rows.
methoddeleteRows(rowIndex, totalRows, updateReference)
Deletes multiple rows in the worksheet.
methoddispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
methodendCellInColumn(startRow, endRow, startColumn, endColumn)
Gets the last cell with maximum column index in this range.
methodendCellInColumn(columnIndex)
Gets the last cell in this column.
methodendCellInRow(rowIndex)
Gets the last cell in this row.
methodendCellInRow(startRow, endRow, startColumn, endColumn)
Gets the last cell with maximum row index in this range.
methodfind(what, previousCell)
Finds the cell containing with the input object.
methodfind(what, previousCell, findOptions)
Finds the cell containing with the input object.
methodgetCellStyle(row, column)
Get the style of given cell.
methodgetColumnOriginalWidthPoint(column)
Gets original column's height in unit of point if the column is hidden
methodgetColumnWidth(column)
Gets the width(in unit of characters) of the specified column in normal view
methodgetColumnWidth(column, isOriginal, unitType)
Gets the column width.
methodgetColumnWidthInch(column)
Gets the width of the specified column in normal view, in units of inches.
methodgetColumnWidthPixel(column)
Gets the width of the specified column in normal view, in units of pixel.
methodgetColumnWidthPixel(column, original)
Gets the width of the specified column in normal view, in units of pixel.
methodgetDependents(isAll, row, column)
Get all cells which refer to the specific cell.
methodgetDependentsInCalculation(row, column, recursive)
Gets all cells whose calculated result depends on specific cell.
methodgetGroupedColumnOutlineLevel(columnIndex)
Gets the outline level (zero-based) of the column.
methodgetGroupedRowOutlineLevel(rowIndex)
Gets the outline level (zero-based) of the row.
methodgetLastDataRow(column)
Gets the last row index of cell which contains data in the specified column.
methodgetMaxGroupedColumnOutlineLevel()
Gets the max grouped column outline level (zero-based).
methodgetMaxGroupedRowOutlineLevel()
Gets the max grouped row outline level (zero-based).
methodgetMergedAreas()
Gets all merged cells.
methodgetRowEnumerator()
Gets the rows enumerator.
methodgetRowHeight(row)
Gets the height of a specified row, in unit of points.
methodgetRowHeight(row, isOriginal, unitType)
Gets row's height.
methodgetRowHeightInch(row)
Gets the height of a specified row in unit of inches.
methodgetRowHeightPixel(row)
Gets the height of a specified row in unit of pixel.
methodgetRowOriginalHeightPoint(row)
Gets original row's height in unit of point if the row is hidden
methodgetViewColumnWidthPixel(column)
Get the width in different view type.
methodgetViewRowHeight(row)
Gets the height of a specified row.
methodgetViewRowHeightInch(row)
Gets the height of a specified row in unit of inches.
methodgroupColumns(firstIndex, lastIndex)
Groups columns.
methodgroupColumns(firstIndex, lastIndex, isHidden)
Groups columns.
methodgroupRows(firstIndex, lastIndex)
Groups rows.
methodgroupRows(firstIndex, lastIndex, isHidden)
Groups rows.
methodhideColumn(column)
Hides a column.
methodhideColumns(column, totalColumns)
Hide multiple columns.
methodhideGroupDetail(isVertical, index)
Collapses the grouped rows/columns.
methodhideRow(row)
Hides a row.
methodhideRows(row, totalRows)
Hides multiple rows.
methodimportCSV(fileName, options, firstRow, firstColumn)
Import a CSV file to the cells.
methodimportCSV(fileName, splitter, convertNumericData, firstRow, firstColumn)
Import a CSV file to the cells.
methodimportCSVFromBytes(byte_array, firstRow, firstColumn, spliter, convertNumericData)
Import a CSV file to the cells.
methodimportCSVFromBytes(byte_array, firstRow, firstColumn, options)
Import a CSV file to the cells.
methodimportFormulaArray(stringArray, firstRow, firstColumn, isVertical)
Imports an array of formula into a worksheet.
methodinsertColumn(columnIndex)
Inserts a new column into the worksheet.
methodinsertColumn(columnIndex, updateReference)
Inserts a new column into the worksheet.
methodinsertColumns(columnIndex, totalColumns)
Inserts some columns into the worksheet.
methodinsertColumns(columnIndex, totalColumns, updateReference)
Inserts some columns into the worksheet.
methodinsertCutCells(cutRange, row, column, shiftType)
Insert cut range.
methodinsertRange(area, shiftType)
Inserts a range of cells and shift cells according to the shift option.
methodinsertRange(area, shiftNumber, shiftType)
Inserts a range of cells and shift cells according to the shift option.
methodinsertRange(area, shiftNumber, shiftType, updateReference)
Inserts a range of cells and shift cells according to the shift option.
methodinsertRow(rowIndex)
Inserts a new row into the worksheet.
methodinsertRows(rowIndex, totalRows)
Inserts multiple rows into the worksheet.
methodinsertRows(rowIndex, totalRows, updateReference)
Inserts multiple rows into the worksheet.
methodinsertRows(rowIndex, totalRows, options)
Inserts multiple rows into the worksheet.
methodisBlankColumn(columnIndex)
Checks whether given column is blank(does not contain any data).
methodisColumnHidden(columnIndex)
Checks whether a column at given index is hidden.
methodisDeletingRangeEnabled(startRow, startColumn, totalRows, totalColumns)
Check whether the range could be deleted.
methodisRowHidden(rowIndex)
Checks whether a row at given index is hidden.
methoditerator()
Gets the cells enumerator.
methodlinkToXmlMap(mapName, row, column, path)
Link to a xml map.
methodmerge(firstRow, firstColumn, totalRows, totalColumns)
Merges a specified range of cells into a single cell.
methodmerge(firstRow, firstColumn, totalRows, totalColumns, mergeConflict)
Merges a specified range of cells into a single cell.
methodmerge(firstRow, firstColumn, totalRows, totalColumns, checkConflict, mergeConflict)
Merges a specified range of cells into a single cell.
methodmoveRange(sourceArea, destRow, destColumn)
Moves the range.
methodremoveDuplicates()
Removes duplicate rows in the sheet.
methodremoveDuplicates(startRow, startColumn, endRow, endColumn)
Removes duplicate values in the range.
methodremoveDuplicates(startRow, startColumn, endRow, endColumn, hasHeaders, columnOffsets)
Removes duplicate data of the range.
methodremoveFormulas()
Removes all formula and replaces with the value of the formula.
methodretrieveSubtotalSetting(ca)
Retrieves subtotals setting of the range.
methodsetColumnWidth(column, width)
Sets the width of the specified column in normal view.
methodsetColumnWidthInch(column, inches)
Sets column width in unit of inches in normal view.
methodsetColumnWidthPixel(column, pixels)
Sets column width in unit of pixels in normal view.
methodsetRowHeight(row, height)
Sets the height of the specified row.
methodsetRowHeightInch(row, inches)
Sets row height in unit of inches.
methodsetRowHeightPixel(row, pixels)
Sets row height in unit of pixels.
methodsetViewColumnWidthPixel(column, pixels)
Sets the width of the column in different view.
methodshowGroupDetail(isVertical, index)
Expands the grouped rows/columns.
methodsubtotal(ca, groupBy, function, totalList)
Creates subtotals for the range.
methodsubtotal(ca, groupBy, function, totalList, replace, pageBreaks, summaryBelowData)
Creates subtotals for the range.
methodtextToColumns(row, column, totalRows, options)
Splits the text in the column to columns.
methodungroupColumns(firstIndex, lastIndex)
Ungroups columns.
methodungroupRows(firstIndex, lastIndex)
Ungroups rows.
methodungroupRows(firstIndex, lastIndex, isAll)
Ungroups rows.
methodunhideColumn(column, width)
Unhides a column
methodunhideColumns(column, totalColumns, width)
Unhide multiple columns.
methodunhideRow(row, height)
Unhides a row.
methodunhideRows(row, totalRows, height)
Unhides the hidden rows.
methodunMerge(firstRow, firstColumn, totalRows, totalColumns)
Unmerges a specified range of merged cells.
 

    • Property Getters/Setters Detail

      • getCount : int 

        int getCount()
        
        Gets the total count of instantiated Cell objects.
      • getCountLarge : long 

        long getCountLarge()
        
        Gets the total count of instantiated Cell objects.
      • getMergedCells : ArrayList 

        ArrayList 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.
      • getMultiThreadReading/setMultiThreadReading : boolean 

        boolean getMultiThreadReading() / setMultiThreadReading(value)
        
        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.
      • getMemorySetting/setMemorySetting : int 

        int getMemorySetting() / setMemorySetting(value)
        
        Gets or sets the memory usage option for this cells. The value of the property is MemorySetting integer constant.
      • getStyle/setStyle : Style 

        Style getStyle() / setStyle(value)
        
        Gets and sets the default style of the worksheet.
      • getStandardWidthInch/setStandardWidthInch : float 

        float getStandardWidthInch() / setStandardWidthInch(value)
        
        Gets or sets the default column width in the worksheet, in unit of inches.
      • getStandardWidthPixels/setStandardWidthPixels : int 

        int getStandardWidthPixels() / setStandardWidthPixels(value)
        
        Gets or sets the default column width in the worksheet, in unit of pixels.
      • getStandardWidth/setStandardWidth : float 

        float getStandardWidth() / setStandardWidth(value)
        
        Gets or sets the default column width in the worksheet, in unit of characters.
      • getStandardHeight/setStandardHeight : float 

        float getStandardHeight() / setStandardHeight(value)
        
        Gets or sets the default row height in this worksheet, in unit of points.
      • getStandardHeightPixels/setStandardHeightPixels : int 

        int getStandardHeightPixels() / setStandardHeightPixels(value)
        
        Gets or sets the default row height in this worksheet, in unit of pixels.
      • getStandardHeightInch/setStandardHeightInch : float 

        float getStandardHeightInch() / setStandardHeightInch(value)
        
        Gets or sets the default row height in this worksheet, in unit of inches.
      • getPreserveString/setPreserveString : boolean 

        boolean getPreserveString() / setPreserveString(value)
        
        Gets or sets a value indicating whether all worksheet values are preserved as strings. Default is false.
      • getMinRow : int 

        int getMinRow()
        
        Minimum row index of cell which contains data or style.
      • getMaxRow : int 

        int 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.
      • getMinColumn : int 

        int 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).
      • getMaxColumn : int 

        int 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.
      • getMinDataRow : int 

        int getMinDataRow()
        
        Minimum row index of cell which contains data.
      • getMaxDataRow : int 

        int getMaxDataRow()
        
        Maximum row index of cell which contains data. Return -1 if there is no cell which contains data.
      • getMinDataColumn : int 

        int 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.
      • getMaxDataColumn : int 

        int 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.
      • isDefaultRowHeightMatched/setDefaultRowHeightMatched : boolean 

        boolean isDefaultRowHeightMatched() / setDefaultRowHeightMatched(value)
        
        Indicates that row height and default font height matches
      • isDefaultRowHidden/setDefaultRowHidden : boolean 

        boolean isDefaultRowHidden() / setDefaultRowHidden(value)
        
        Indicates whether the row is default hidden.
      • getLastCell : Cell 

        Cell getLastCell()
        
        Gets the last cell in this worksheet. Returns null if there is no data in the worksheet.
      • getMaxDisplayRange : Range 

        Range 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.
      • getFirstCell : Cell 

        Cell getFirstCell()
        
        Gets the first cell in this worksheet. Returns null if there is no data in the worksheet.
      • get : Cell 

        Cell get(row, column)
        
        Gets the Cell element at the specified cell row index and column index.
        Parameters:
        row - Row index.
        column - Column index.
        Returns:
        The Cell object.

        Example:

        excel = Workbook()
        cells = excel.getWorksheets().get(0).getCells()
        # Gets the cell at "A1"
        cell = cells.get(0, 0)
      • get : Cell 

        Cell get(cellName)
        
        Gets the Cell element at the specified cell name.
        Parameters:
        cellName - Cell name,including its column letter and row number, for example A5.
        Returns:
        A Cell object

        Example:

        excel = Workbook()
        cells = excel.getWorksheets().get(0).getCells()
        # Gets the cell at "A1"
        cell = cells.get("A1")
    • Method Detail

      • deleteRange

         deleteRange(startRow, startColumn, endRow, endColumn, shiftType)
        Deletes a range of cells and shift cells according to the shift option.
        Parameters:
        startRow: int - Start row index.
        startColumn: int - Start column index.
        endRow: int - End row index.
        endColumn: int - End column index.
        shiftType: int - A ShiftType value. Shift cells option.
      • retrieveSubtotalSetting

        SubtotalSetting retrieveSubtotalSetting(ca)
        Retrieves subtotals setting of the range.
        Parameters:
        ca: CellArea - The range
        Returns:
      • subtotal

         subtotal(ca, groupBy, function, totalList)
        Creates subtotals for the range.
        Parameters:
        ca: CellArea - The range
        groupBy: int - The field to group by, as a zero-based integer offset
        function: int - A ConsolidationFunction value. The subtotal function.
        totalList: Number Array - An array of zero-based field offsets, indicating the fields to which the subtotals are added.
      • subtotal

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

         removeFormulas()
        Removes all formula and replaces with the value of the formula.
      • removeDuplicates

         removeDuplicates()
        Removes duplicate rows in the sheet.
      • removeDuplicates

         removeDuplicates(startRow, startColumn, endRow, endColumn)
        Removes duplicate values in the range.
        Parameters:
        startRow: int - The start row.
        startColumn: int - The start column
        endRow: int - The end row index.
        endColumn: int - The end column index.
      • removeDuplicates

         removeDuplicates(startRow, startColumn, endRow, endColumn, hasHeaders, columnOffsets)
        Removes duplicate data of the range.
        Parameters:
        startRow: int - The start row.
        startColumn: int - The start column
        endRow: int - The end row index.
        endColumn: int - The end column index.
        hasHeaders: boolean - Indicates whether the range contains headers.
        columnOffsets: Number Array - The column offsets.
      • convertStringToNumericValue

         convertStringToNumericValue()
        Converts all string data in the worksheet to numeric value if possible.
      • getDependents

        Cell[] getDependents(isAll, row, column)
        Get all cells which refer to the specific cell.
        Parameters:
        isAll: boolean - Indicates whether check other worksheets
        row: int - The row index.
        column: int - The column index.
        Returns:
      • getDependentsInCalculation

        Iterator 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)
        Parameters:
        row: int - Row index of the specific cell
        column: int - Column index of the specific cell.
        recursive: boolean - Whether returns those dependents which do not reference to the specific cell directly but reference to other leafs of that cell.
        Returns:
        Enumerator to enumerate all dependents(Cell objects)
      • getCellStyle

        Style getCellStyle(row, column)
        Get the style of given cell.
        Parameters:
        row: int - row index
        column: int - column
        Returns:
        the style of given cell.
      • setViewColumnWidthPixel

         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:
        column: int - The column index.
        pixels: int - The width in unit of pixels.
      • getLastDataRow

        int getLastDataRow(column)
        Gets the last row index of cell which contains data in the specified column.
        Parameters:
        column: int - Column index.
        Returns:
        last row index.
      • applyColumnStyle

         applyColumnStyle(column, style, flag)
        Applies formats for a whole column.
        Parameters:
        column: int - The column index.
        style: Style - The style object which will be applied.
        flag: StyleFlag - Flags which indicates applied formatting properties.
      • applyRowStyle

         applyRowStyle(row, style, flag)
        Applies formats for a whole row.
        Parameters:
        row: int - The row index.
        style: Style - The style object which will be applied.
        flag: StyleFlag - Flags which indicates applied formatting properties.
      • applyStyle

         applyStyle(style, flag)
        Applies formats for a whole worksheet.
        Parameters:
        style: Style - The style object which will be applied.
        flag: StyleFlag - Flags which indicates applied formatting properties.
      • copyColumns

         copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber, pasteOptions)
        Copies data and formats of a whole column.
        Parameters:
        sourceCells0: Cells - Source Cells object contains data and formats to copy.
        sourceColumnIndex: int - Source column index.
        destinationColumnIndex: int - Destination column index.
        columnNumber: int - The copied column number.
        pasteOptions: PasteOptions - the options of pasting.
      • copyColumn

         copyColumn(sourceCells, sourceColumnIndex, destinationColumnIndex)
        Copies data and formats of a whole column.
        Parameters:
        sourceCells: Cells - Source Cells object contains data and formats to copy.
        sourceColumnIndex: int - Source column index.
        destinationColumnIndex: int - Destination column index.
      • copyColumns

         copyColumns(sourceCells0, sourceColumnIndex, destinationColumnIndex, columnNumber)
        Copies data and formats of a whole column.
        Parameters:
        sourceCells0: Cells - Source Cells object contains data and formats to copy.
        sourceColumnIndex: int - Source column index.
        destinationColumnIndex: int - Destination column index.
        columnNumber: int - The copied column number.
      • copyColumns

         copyColumns(sourceCells, sourceColumnIndex, sourceTotalColumns, destinationColumnIndex, destinationTotalColumns)
        Copies data and formats of the whole columns.
        Parameters:
        sourceCells: Cells - Source Cells object contains data and formats to copy.
        sourceColumnIndex: int - Source column index.
        sourceTotalColumns: int - The number of the source columns.
        destinationColumnIndex: int - Destination column index.
        destinationTotalColumns: int - The number of the destination columns.
      • copyRow

         copyRow(sourceCells, sourceRowIndex, destinationRowIndex)
        Copies data and formats of a whole row.
        Parameters:
        sourceCells: Cells - Source Cells object contains data and formats to copy.
        sourceRowIndex: int - Source row index.
        destinationRowIndex: int - Destination row index.
      • copyRows

         copyRows(sourceCells, sourceRowIndex, destinationRowIndex, rowNumber)
        Copies data and formats of some whole rows.
        Parameters:
        sourceCells: Cells - Source Cells object contains data and formats to copy.
        sourceRowIndex: int - Source row index.
        destinationRowIndex: int - Destination row index.
        rowNumber: int - The copied row number.
      • copyRows

         copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions)
        Copies data and formats of some whole rows.
        Parameters:
        sourceCells0: Cells - Source Cells object contains data and formats to copy.
        sourceRowIndex: int - Source row index.
        destinationRowIndex: int - Destination row index.
        rowNumber: int - The copied row number.
        copyOptions: CopyOptions - The copy options.
      • copyRows

         copyRows(sourceCells0, sourceRowIndex, destinationRowIndex, rowNumber, copyOptions, pasteOptions)
        Copies data and formats of some whole rows.
        Parameters:
        sourceCells0: Cells - Source Cells object contains data and formats to copy.
        sourceRowIndex: int - Source row index.
        destinationRowIndex: int - Destination row index.
        rowNumber: int - The copied row number.
        copyOptions: CopyOptions - The copy options.
        pasteOptions: PasteOptions - the options of pasting.
      • getGroupedRowOutlineLevel

        int getGroupedRowOutlineLevel(rowIndex)
        Gets the outline level (zero-based) of the row. If the row is not grouped, returns zero.
        Parameters:
        rowIndex: int - The row index.
        Returns:
        The outline level (zero-based) of the row.
      • getGroupedColumnOutlineLevel

        int getGroupedColumnOutlineLevel(columnIndex)
        Gets the outline level (zero-based) of the column. If the column is not grouped, returns zero.
        Parameters:
        columnIndex: int - The column index
        Returns:
        The outline level of the column
      • getMaxGroupedColumnOutlineLevel

        int getMaxGroupedColumnOutlineLevel()
        Gets the max grouped column outline level (zero-based).
        Returns:
        The max grouped column outline level (zero-based)
      • getMaxGroupedRowOutlineLevel

        int getMaxGroupedRowOutlineLevel()
        Gets the max grouped row outline level (zero-based).
        Returns:
        The max grouped row outline level (zero-based)
      • showGroupDetail

         showGroupDetail(isVertical, index)
        Expands the grouped rows/columns.
        Parameters:
        isVertical: boolean - True, expands the grouped rows.
        index: int - The row/column index
      • hideGroupDetail

         hideGroupDetail(isVertical, index)
        Collapses the grouped rows/columns.
        Parameters:
        isVertical: boolean - True, collapse the grouped rows.
        index: int - The row/column index
      • ungroupColumns

         ungroupColumns(firstIndex, lastIndex)
        Ungroups columns.
        Parameters:
        firstIndex: int - The first column index to be ungrouped.
        lastIndex: int - The last column index to be ungrouped.
      • groupColumns

         groupColumns(firstIndex, lastIndex)
        Groups columns.
        Parameters:
        firstIndex: int - The first column index to be grouped.
        lastIndex: int - The last column index to be grouped.
      • groupColumns

         groupColumns(firstIndex, lastIndex, isHidden)
        Groups columns.
        Parameters:
        firstIndex: int - The first column index to be grouped.
        lastIndex: int - The last column index to be grouped.
        isHidden: boolean - Specifies if the grouped columns are hidden.
      • ungroupRows

         ungroupRows(firstIndex, lastIndex, isAll)
        Ungroups rows.
        Parameters:
        firstIndex: int - The first row index to be ungrouped.
        lastIndex: int - The last row index to be ungrouped.
        isAll: boolean - True, removes all grouped info.Otherwise, remove the outer group info.
      • ungroupRows

         ungroupRows(firstIndex, lastIndex)
        Ungroups rows. Only removes outer group info.
        Parameters:
        firstIndex: int - The first row index to be ungrouped.
        lastIndex: int - The last row index to be ungrouped.
      • groupRows

         groupRows(firstIndex, lastIndex, isHidden)
        Groups rows.
        Parameters:
        firstIndex: int - The first row index to be grouped.
        lastIndex: int - The last row index to be grouped.
        isHidden: boolean - Specifies if the grouped rows are hidden.
      • groupRows

         groupRows(firstIndex, lastIndex)
        Groups rows.
        Parameters:
        firstIndex: int - The first row index to be grouped.
        lastIndex: int - The last row index to be grouped.
      • deleteColumn

         deleteColumn(columnIndex, updateReference)
        Deletes a column.
        Parameters:
        columnIndex: int - Index of the column to be deleted.
        updateReference: boolean - Indicates whether update references in other worksheets.
      • deleteColumn

         deleteColumn(columnIndex)
        Deletes a column.
        Parameters:
        columnIndex: int - Index of the column to be deleted.
      • deleteColumns

         deleteColumns(columnIndex, totalColumns, updateReference)
        Deletes several columns.
        Parameters:
        columnIndex: int - Index of the first column to be deleted.
        totalColumns: int - Count of columns to be deleted.
        updateReference: boolean - Indicates whether update references in other worksheets.
      • isDeletingRangeEnabled

        boolean isDeletingRangeEnabled(startRow, startColumn, totalRows, totalColumns)
        Check whether the range could be deleted.
        Parameters:
        startRow: int - The start row index of the range.
        startColumn: int - The start column index of the range.
        totalRows: int - The number of the rows in the range.
        totalColumns: int - The number of the columns in the range.
        Returns:
      • deleteRow

         deleteRow(rowIndex)
        Deletes a row.
        Parameters:
        rowIndex: int - Index of the row to be deleted.
      • deleteRows

        boolean 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.
        Parameters:
        rowIndex: int - The first row index to be deleted.
        totalRows: int - Count of rows to be deleted.
      • deleteRow

         deleteRow(rowIndex, updateReference)
        Deletes a row.
        Parameters:
        rowIndex: int - Index of the row to be deleted.
        updateReference: boolean - Indicates whether update references in other worksheets.
      • deleteRows

        boolean deleteRows(rowIndex, totalRows, updateReference)
        Deletes multiple rows in the worksheet.
        Parameters:
        rowIndex: int - Index of the first row to be deleted.
        totalRows: int - Count of rows to be deleted.
        updateReference: boolean - Indicates whether update references in other worksheets.
        Returns:
      • deleteBlankColumns

         deleteBlankColumns()
        Delete all blank columns which do not contain any data.
      • deleteBlankColumns

         deleteBlankColumns(options)
        Delete all blank columns which do not contain any data.
        Parameters:
        options: DeleteOptions - The options of deleting range.
      • isBlankColumn

        boolean isBlankColumn(columnIndex)
        Checks whether given column is blank(does not contain any data).
        Parameters:
        columnIndex: int - the column index
        Returns:
        true if given column does not contain any data
      • deleteBlankRows

         deleteBlankRows()
        Delete all blank rows which do not contain any data or other object.
      • deleteBlankRows

         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.
        Parameters:
        options: DeleteOptions - The options of deleting range.
      • insertColumns

         insertColumns(columnIndex, totalColumns)
        Inserts some columns into the worksheet.
        Parameters:
        columnIndex: int - Column index.
        totalColumns: int - The number of columns.
      • insertColumns

         insertColumns(columnIndex, totalColumns, updateReference)
        Inserts some columns into the worksheet.
        Parameters:
        columnIndex: int - Column index.
        totalColumns: int - The number of columns.
        updateReference: boolean - Indicates if references in other worksheets will be updated.
      • insertColumn

         insertColumn(columnIndex, updateReference)
        Inserts a new column into the worksheet.
        Parameters:
        columnIndex: int - Column index.
        updateReference: boolean - Indicates if references in other worksheets will be updated.
      • insertColumn

         insertColumn(columnIndex)
        Inserts a new column into the worksheet.
        Parameters:
        columnIndex: int - Column index.
      • insertRows

         insertRows(rowIndex, totalRows, updateReference)
        Inserts multiple rows into the worksheet.
        Parameters:
        rowIndex: int - Row index.
        totalRows: int - Number of rows to be inserted.
        updateReference: boolean - Indicates if references in other worksheets will be updated.
      • insertRows

         insertRows(rowIndex, totalRows, options)
        Inserts multiple rows into the worksheet.
        Parameters:
        rowIndex: int - Row index.
        totalRows: int - Number of rows to be inserted.
        options: InsertOptions - Indicates if references in other worksheets will be updated.
      • insertRows

         insertRows(rowIndex, totalRows)
        Inserts multiple rows into the worksheet.
        Parameters:
        rowIndex: int - Row index.
        totalRows: int - Number of rows to be inserted.
      • insertRow

         insertRow(rowIndex)
        Inserts a new row into the worksheet.
        Parameters:
        rowIndex: int - Row index.
      • clearRange

         clearRange(range)
        Clears contents and formatting of a range.
        Parameters:
        range: CellArea - Range to be cleared.
      • clearRange

         clearRange(startRow, startColumn, endRow, endColumn)
        Clears contents and formatting of a range.
        Parameters:
        startRow: int - Start row index.
        startColumn: int - Start column index.
        endRow: int - End row index.
        endColumn: int - End column index.
      • clearContents

         clearContents(range)
        Clears contents of a range.
        Parameters:
        range: CellArea - Range to be cleared.
      • clearContents

         clearContents(startRow, startColumn, endRow, endColumn)
        Clears contents of a range.
        Parameters:
        startRow: int - Start row index.
        startColumn: int - Start column index.
        endRow: int - End row index.
        endColumn: int - End column index.
      • clearFormats

         clearFormats(range)
        Clears formatting of a range.
        Parameters:
        range: CellArea - Range to be cleared.
      • clearFormats

         clearFormats(startRow, startColumn, endRow, endColumn)
        Clears formatting of a range.
        Parameters:
        startRow: int - Start row index.
        startColumn: int - Start column index.
        endRow: int - End row index.
        endColumn: int - End column index.
      • linkToXmlMap

         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:
        mapName: String - name of xml map
        row: int - row of the destination cell
        column: int - column of the destination cell
        path: String - path of xml element in xml map
      • find

        Cell find(what, previousCell)
        Finds the cell containing with the input object. Returns null (Nothing) if no cell is found.
        Parameters:
        what: Object - The object to search for. The type should be int,double,DateTime,string,bool.
        previousCell: Cell - Previous cell with the same object. This parameter can be set to null if searching from the start.
        Returns:
        Cell object.
      • find

        Cell find(what, previousCell, findOptions)
        Finds the cell containing with the input object. Returns null (Nothing) if no cell is found.
        Parameters:
        what: Object - The object to search for. The type should be int,double,DateTime,string,bool.
        previousCell: Cell - Previous cell with the same object. This parameter can be set to null if searching from the start.
        findOptions: FindOptions - Find options
        Returns:
        Cell object.
      • endCellInRow

        Cell endCellInRow(rowIndex)
        Gets the last cell in this row.
        Parameters:
        rowIndex: int - Row index.
        Returns:
        Cell object.
      • endCellInColumn

        Cell endCellInColumn(columnIndex)
        Gets the last cell in this column.
        Parameters:
        columnIndex: int - Column index.
        Returns:
        Cell object.
      • endCellInColumn

        Cell endCellInColumn(startRow, endRow, startColumn, endColumn)
        Gets the last cell with maximum column index in this range.
        Parameters:
        startRow: int - Start row index.
        endRow: int - End row index.
        startColumn: int - Start column index.
        endColumn: int - End column index.
        Returns:
        Cell object.
      • endCellInRow

        Cell endCellInRow(startRow, endRow, startColumn, endColumn)
        Gets the last cell with maximum row index in this range.
        Parameters:
        startRow: int - Start row index.
        endRow: int - End row index.
        startColumn: int - Start column index.
        endColumn: int - End column index.
        Returns:
        Cell object.
      • moveRange

         moveRange(sourceArea, destRow, destColumn)
        Moves the range.
        Parameters:
        sourceArea: CellArea - The range which should be moved.
        destRow: int - The dest row.
        destColumn: int - The dest column.
      • insertCutCells

         insertCutCells(cutRange, row, column, shiftType)
        Insert cut range.
        Parameters:
        cutRange: Range - The cut range.
        row: int - The row.
        column: int - The column.
        shiftType: int - A ShiftType value. The shift type .
      • insertRange

         insertRange(area, shiftNumber, shiftType, updateReference)
        Inserts a range of cells and shift cells according to the shift option.
        Parameters:
        area: CellArea - Shift area.
        shiftNumber: int - Number of rows or columns to be inserted.
        shiftType: int - A ShiftType value. Shift cells option.
        updateReference: boolean - Indicates whether update references in other worksheets.
      • insertRange

         insertRange(area, shiftType)
        Inserts a range of cells and shift cells according to the shift option.
        Parameters:
        area: CellArea - Shift area.
        shiftType: int - A ShiftType value. Shift cells option.
      • insertRange

         insertRange(area, shiftNumber, shiftType)
        Inserts a range of cells and shift cells according to the shift option.
        Parameters:
        area: CellArea - Shift area.
        shiftNumber: int - Number of rows or columns to be inserted.
        shiftType: int - A ShiftType value. Shift cells option.
      • dispose

         dispose()
        Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
      • iterator

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

        Iterator getRowEnumerator()
        Gets the rows enumerator. NOTE: This member is now obsolete. Instead, please use RowCollection.GetEnumerator() method. This method will be removed 12 months later since May 2023. Aspose apologizes for any inconvenience you may have experienced.
        Returns:
        The rows enumerator.
        See Also:
        RowCollection.iterator()
      • getMergedAreas

        CellArea[] getMergedAreas()
        Gets all merged cells.
      • checkCell

        Cell checkCell(row, column)
        Gets the Cell element or null at the specified cell row index and column index.
        Parameters:
        row: int - Row index
        column: int - Column index
        Returns:
        Return Cell object if a Cell object exists. Return null if the cell does not exist.
      • checkRow

        Row checkRow(row)
        Gets the Row element or null at the specified cell row index.
        Parameters:
        row: int - Row index
        Returns:
        Returns Row object If the row object does exist, otherwise returns null.
      • checkColumn

        Column checkColumn(columnIndex)
        Gets the Column element or null at the specified column index.
        Parameters:
        columnIndex: int - The column index.
        Returns:
        The Column object.
      • isRowHidden

        boolean isRowHidden(rowIndex)
        Checks whether a row at given index is hidden.
        Parameters:
        rowIndex: int - row index
        Returns:
        true if the row is hidden
      • isColumnHidden

        boolean isColumnHidden(columnIndex)
        Checks whether a column at given index is hidden.
        Parameters:
        columnIndex: int - column index
        Returns:
        true if the column is hidden.
      • addRange

         addRange(rangeObject)
        Adds a range object reference to cells
        Parameters:
        rangeObject: Range - The range object will be contained in the cells
      • createRange

        Range createRange(upperLeftCell, lowerRightCell)
        Creates a Range object from a range of cells.
        Parameters:
        upperLeftCell: String - Upper left cell name.
        lowerRightCell: String - Lower right cell name.
        Returns:
        A Range object
      • createRange

        Range createRange(firstRow, firstColumn, totalRows, totalColumns)
        Creates a Range object from a range of cells.
        Parameters:
        firstRow: int - First row of this range
        firstColumn: int - First column of this range
        totalRows: int - Number of rows
        totalColumns: int - Number of columns
        Returns:
        A Range object
      • createRange

        Range createRange(address)
        Creates a Range object from an address of the range.
        Parameters:
        address: String - The address of the range.
        Returns:
        A Range object
      • createRange

        Range createRange(firstIndex, number, isVertical)
        Creates a Range object from rows of cells or columns of cells.
        Parameters:
        firstIndex: int - First row index or first column index, zero based.
        number: int - Total number of rows or columns, one based.
        isVertical: boolean - True - Range created from columns of cells. False - Range created from rows of cells.
        Returns:
        A Range object.
      • clear

         clear()
        Clears all data of the worksheet.
      • importFormulaArray

         importFormulaArray(stringArray, firstRow, firstColumn, isVertical)
        Imports an array of formula into a worksheet.
        Parameters:
        stringArray: String[] - Formula array.
        firstRow: int - The row number of the first cell to import in.
        firstColumn: int - The column number of the first cell to import in.
        isVertical: boolean - Specifies to import data vertically or horizontally.
      • textToColumns

         textToColumns(row, column, totalRows, options)
        Splits the text in the column to columns.
        Parameters:
        row: int - The row index.
        column: int - The column index.
        totalRows: int - The number of rows.
        options: TxtLoadOptions - The split options.
      • importCSV

         importCSV(fileName, splitter, convertNumericData, firstRow, firstColumn)
        Import a CSV file to the cells.
        Parameters:
        fileName: String - The CSV file name.
        splitter: String - The splitter
        convertNumericData: boolean - Whether the string in text file is converted to numeric data.
        firstRow: int - The row number of the first cell to import in.
        firstColumn: int - The column number of the first cell to import in.
      • importCSV

         importCSV(fileName, options, firstRow, firstColumn)
        Import a CSV file to the cells.
        Parameters:
        fileName: String - The CSV file name.
        options: TxtLoadOptions - The load options for reading text file
        firstRow: int - The row number of the first cell to import in.
        firstColumn: int - The column number of the first cell to import in.
      • merge

         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:
        firstRow: int - First row of this range(zero based)
        firstColumn: int - First column of this range(zero based)
        totalRows: int - Number of rows(one based)
        totalColumns: int - Number of columns(one based)
      • merge

         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:
        firstRow: int - First row of this range(zero based)
        firstColumn: int - First column of this range(zero based)
        totalRows: int - Number of rows(one based)
        totalColumns: int - Number of columns(one based)
        mergeConflict: boolean - Merge conflict merged ranges.
      • merge

         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:
        firstRow: int - First row of this range(zero based)
        firstColumn: int - First column of this range(zero based)
        totalRows: int - Number of rows(one based)
        totalColumns: int - Number of columns(one based)
        checkConflict: boolean - Indicates whether check the merged cells intersects other merged cells
        mergeConflict: boolean - Merge conflict merged ranges.
      • unMerge

         unMerge(firstRow, firstColumn, totalRows, totalColumns)
        Unmerges a specified range of merged cells.
        Parameters:
        firstRow: int - First row of this range(zero based)
        firstColumn: int - First column of this range(zero based)
        totalRows: int - Number of rows(one based)
        totalColumns: int - Number of columns(one based)
      • clearMergedCells

         clearMergedCells()
        Clears all merged ranges.
      • hideRow

         hideRow(row)
        Hides a row.
        Parameters:
        row: int - Row index.
      • unhideRow

         unhideRow(row, height)
        Unhides a row.
        Parameters:
        row: int - Row index.
        height: float - Row height. The row's height will be changed only when the row is hidden and given height value is positive.
      • hideRows

         hideRows(row, totalRows)
        Hides multiple rows.
        Parameters:
        row: int - The row index.
        totalRows: int - The row number.
      • unhideRows

         unhideRows(row, totalRows, height)
        Unhides the hidden rows.
        Parameters:
        row: int - The row index.
        totalRows: int - The row number.
        height: float - Row height. The row's height will be changed only when the row is hidden and given height value is positive.
      • setRowHeightPixel

         setRowHeightPixel(row, pixels)
        Sets row height in unit of pixels.
        Parameters:
        row: int - Row index.
        pixels: int - Number of pixels.
      • setRowHeightInch

         setRowHeightInch(row, inches)
        Sets row height in unit of inches.
        Parameters:
        row: int - Row index.
        inches: float - Number of inches. It should be between 0 and 409.5/72.
      • setRowHeight

         setRowHeight(row, height)
        Sets the height of the specified row.
        Parameters:
        row: int - Row index.
        height: float - Height of row.In unit of point It should be between 0 and 409.5.
      • getRowHeight

        float getRowHeight(row, isOriginal, unitType)
        Gets row's height.
        Parameters:
        row: int - The row index.
        isOriginal: boolean - Whether returns the original row height or 0 for hidden row.
        unitType: int - A CellsUnitType value. Unit type of the returned height value
        Returns:
        Row's height
      • getRowOriginalHeightPoint

        float 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.
        Parameters:
        row: int - The row index.
        Returns:
      • getColumnWidth

        float getColumnWidth(column, isOriginal, unitType)
        Gets the column width.
        Parameters:
        column: int - The column index.
        isOriginal: boolean - Indicates whether getting original width.
        unitType: int - A CellsUnitType value.
        Returns:
      • getColumnOriginalWidthPoint

        float getColumnOriginalWidthPoint(column)
        Gets original column's height in unit of point if the column is hidden
      • hideColumn

         hideColumn(column)
        Hides a column.
        Parameters:
        column: int - Column index.
      • unhideColumn

         unhideColumn(column, width)
        Unhides a column
        Parameters:
        column: int - Column index.
        width: float - Column width.
      • hideColumns

         hideColumns(column, totalColumns)
        Hide multiple columns.
        Parameters:
        column: int - Column index.
        totalColumns: int - Column number.
      • unhideColumns

         unhideColumns(column, totalColumns, width)
        Unhide multiple columns. Only applies the column width to the hidden columns.
        Parameters:
        column: int - Column index.
        totalColumns: int - Column number
        width: float - Column width.
      • getRowHeight

        float getRowHeight(row)
        Gets the height of a specified row, in unit of points.
        Parameters:
        row: int - Row index
        Returns:
        Height of row
      • getViewRowHeight

        float getViewRowHeight(row)
        Gets the height of a specified row.
        Parameters:
        row: int - Row index.
        Returns:
        Height of row.
      • getRowHeightInch

        float getRowHeightInch(row)
        Gets the height of a specified row in unit of inches.
        Parameters:
        row: int - Row index
        Returns:
        Height of row
      • getViewRowHeightInch

        float getViewRowHeightInch(row)
        Gets the height of a specified row in unit of inches.
        Parameters:
        row: int - Row index
        Returns:
        Height of row
      • getRowHeightPixel

        int getRowHeightPixel(row)
        Gets the height of a specified row in unit of pixel.
        Parameters:
        row: int - Row index
        Returns:
        Height of row
      • setColumnWidthPixel

         setColumnWidthPixel(column, pixels)
        Sets column width in unit of pixels in normal view.
        Parameters:
        column: int - Column index.
        pixels: int - Number of pixels.
      • setColumnWidthInch

         setColumnWidthInch(column, inches)
        Sets column width in unit of inches in normal view.
        Parameters:
        column: int - Column index.
        inches: float - Number of inches.
      • setColumnWidth

         setColumnWidth(column, width)
        Sets the width of the specified column in normal view. To hide a column, sets column width to zero.
        Parameters:
        column: int - Column index.
        width: float - Width of column.Column width must be between 0 and 255.
      • getColumnWidthPixel

        int getColumnWidthPixel(column)
        Gets the width of the specified column in normal view, in units of pixel.
        Parameters:
        column: int - Column index
        Returns:
        Width of column in normal view.
      • getColumnWidthPixel

        int 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.
        Parameters:
        column: int - Column index
        original: boolean - Indicates whether returning original width even when the column is hidden
        Returns:
        Width of column in normal view.
      • getColumnWidthInch

        float getColumnWidthInch(column)
        Gets the width of the specified column in normal view, in units of inches.
      • getColumnWidth

        float getColumnWidth(column)
        Gets the width(in unit of characters) of the specified column in normal view
        Parameters:
        column: int - Column index
        Returns:
        Width of column. For spreadsheet, column width is measured as the number of characters of the maximum digit width of the numbers 0~9 as rendered in the normal style's font.
      • getViewColumnWidthPixel

        int getViewColumnWidthPixel(column)
        Get the width in different view type.
        Parameters:
        column: int - The column index.
        Returns:
        the column width in unit of pixels
      • importCSVFromBytes

         importCSVFromBytes(byte_array, firstRow, firstColumn, spliter, convertNumericData)
        Import a CSV file to the cells.
        Parameters:
        byte_array: bytes - The byte array
        firstRow: int - The row number of the first cell to import in
        firstColumn: int - The column number of the first cell to import in
        spliter: String - The spliter
        convertNumericData: boolean - Whether the string in text file is converted to numeric data

        Example:

        import jpype
        import asposecells
        jpype.startJVM()
        from asposecells.api import *
        
        wb = Workbook()
        cells = wb.getWorksheets().get(0).getCells()
        with open('EmployeeList.csv', 'rb') as f:
            cells.importCSVFromBytes(f.read(), 0, 1, spliter=",", convertNumericData=False)
        wb.save("wb.xlsx")
        
        jpype.shutdownJVM()
        				
      • importCSVFromBytes

         importCSVFromBytes(byte_array, firstRow, firstColumn, options)
        Import a CSV file to the cells.
        Parameters:
        byte_array: bytes - The byte array
        firstRow: int - The row number of the first cell to import in
        firstColumn: int - The column number of the first cell to import in
        options: TxtLoadOptions - The load options for reading text file

        Example:

        import jpype
        import asposecells
        jpype.startJVM()
        from asposecells.api import *
        
        wb = Workbook()
        cells = wb.getWorksheets().get(0).getCells()
        loadOptions = TxtLoadOptions()
        with open('EmployeeList.csv', 'rb') as f:
            cells.importCSVFromBytes(f.read(), 0, 1, options=loadOptions)
        wb.save("wb.xlsx")
        
        jpype.shutdownJVM()