com.aspose.cells

  • java.lang.Object
    • com.aspose.cells.Cells
  • All Implemented Interfaces:
    java.lang.Iterable
    public class Cells 
    extends java.lang.Object

Encapsulates a collection of Cell objects.

Example:

Workbook excel = new Workbook();
Cells 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
ColumnCollectiongetColumns()
Gets the collection of Column objects that represents the individual columns in this worksheet.
intgetCount()
Gets the number of cells.
CellgetEnd()
Gets the last cell in this worksheet.
CellgetFirstCell()
Gets the first cell in this worksheet.
booleanisDefaultRowHeightMatched()
void
Indicates that row height and default font height matches
booleanisDefaultRowHidden()
void
setDefaultRowHidden(booleanvalue)
Indicates whether the row is defaultly hidden.
CellgetLastCell()
Gets the last cell in this worksheet.
intgetMaxColumn()
Maximum column index of cell which contains data or style.
intgetMaxDataColumn()
Maximum column index of cell which contains data.
intgetMaxDataRow()
Maximum row index of cell which contains data.
RangegetMaxDisplayRange()
Gets the max range which includes data, merged cells and shapes.
intgetMaxRow()
Maximum row index of cell which contains data or style.
intgetMemorySetting()
void
Gets or sets the memory usage option for this cells. The value of the property is MemorySetting integer constant.
java.util.ArrayListgetMergedCells()
Gets the collection of merged cells.
intgetMinColumn()
Minimum column index of cell which contains data or style.
intgetMinDataColumn()
Minimum column index of cell which contains data.
intgetMinDataRow()
Minimum row index of cell which contains data.
intgetMinRow()
Minimum row index of cell which contains data or style.
booleangetMultiThreadReading()
void
setMultiThreadReading(booleanvalue)
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.
booleangetPreserveString()
void
setPreserveString(booleanvalue)
Gets or sets a value indicating whether all worksheet values are preserved as strings. Default is false.
RangeCollectiongetRanges()
Gets the collection of Range objects created at run time.
RowCollectiongetRows()
Gets the collection of Row objects that represents the individual rows in this worksheet.
doublegetStandardHeight()
void
setStandardHeight(doublevalue)
Gets or sets the default row height in this worksheet, in unit of points.
intgetStandardHeightPixels()
void
Gets or sets the default row height in this worksheet, in unit of pixels.
doublegetStandardWidth()
void
setStandardWidth(doublevalue)
Gets or sets the default column width in the worksheet, in unit of characters.
doublegetStandardWidthInch()
void
Gets or sets the default column width in the worksheet, in unit of inches.
intgetStandardWidthPixels()
void
Gets or sets the default column width in the worksheet, in unit of pixels.
CellgetStart()
Gets the first cell in this worksheet.
StylegetStyle()
void
setStyle(Style value)
Gets and sets the default style.
Cellget(intindex)
Gets Cell item within the worksheet
Cellget(introw, intcolumn)
Gets the Cell element at the specified cell row index and column index.
Cellget(java.lang.StringcellName)
Gets the Cell element at the specified cell name.
 
Method Summary
voidaddRange(Range rangeObject)
Adds a range object reference to cells
voidapplyColumnStyle(intcolumn, Style style, StyleFlag flag)
Applies formats for a whole column.
voidapplyRowStyle(introw, Style style, StyleFlag flag)
Applies formats for a whole row.
voidapplyStyle(Style style, StyleFlag flag)
Applies formats for a whole worksheet.
CellcheckCell(introw, intcolumn)
Gets the Cell element or null at the specified cell row index and column index.
ColumncheckColumn(intcolumnIndex)
Gets the Column element or null at the specified column index.
RowcheckRow(introw)
Gets the Row element or at the specified cell row index.
voidclear()
Clears all cell and row objects.
voidclearContents(CellArea range)
Clears contents of a range.
voidclearContents(intstartRow, intstartColumn, intendRow, intendColumn)
Clears contents of a range.
voidclearFormats(CellArea range)
Clears formatting of a range.
voidclearFormats(intstartRow, intstartColumn, intendRow, intendColumn)
Clears formatting of a range.
voidclearRange(CellArea range)
Clears contents and formatting of a range.
voidclearRange(intstartRow, intstartColumn, intendRow, intendColumn)
Clears contents and formatting of a range.
voidconvertStringToNumericValue()
Converts string data in cells to numeric value if possible.
voidcopyColumn(Cells sourceCells, intsourceColumnIndex, intdestinationColumnIndex)
Copies data and formats of a whole column.
voidcopyColumns(Cells sourceCells0, intsourceColumnIndex, intdestinationColumnIndex, intcolumnNumber)
Copies data and formats of a whole column.
voidcopyColumns(Cells sourceCells, intsourceColumnIndex, intsourceTotalColumns, intdestinationColumnIndex, intdestinationTotalColumns)
Copies data and formats of the whole columns.
voidcopyRow(Cells sourceCells, intsourceRowIndex, intdestinationRowIndex)
Copies data and formats of a whole row.
voidcopyRows(Cells sourceCells, intsourceRowIndex, intdestinationRowIndex, introwNumber)
Copies data and formats of some whole rows.
voidcopyRows(Cells sourceCells0, intsourceRowIndex, intdestinationRowIndex, introwNumber, CopyOptions copyOptions)
Copies data and formats of some whole rows.
RangecreateRange(intfirstIndex, intnumber, booleanisVertical)
Creates a Range object from rows of cells or columns of cells.
RangecreateRange(intfirstRow, intfirstColumn, inttotalRows, inttotalColumns)
Creates a Range object from a range of cells.
RangecreateRange(java.lang.Stringaddress)
Creates a Range object from an address of the range.
RangecreateRange(java.lang.StringupperLeftCell, java.lang.StringlowerRightCell)
Creates a Range object from a range of cells.
voiddeleteBlankColumns()
Delete all blank columns which do not contain any data.
voiddeleteBlankColumns(DeleteOptions options)
Delete all blank columns which do not contain any data.
voiddeleteBlankRows()
Delete all blank rows which do not contain any data.
voiddeleteBlankRows(DeleteOptions options)
Delete all blank rows which do not contain any data.
voiddeleteColumn(intcolumnIndex)
Deletes a column.
voiddeleteColumn(intcolumnIndex, booleanupdateReference)
Deletes a column.
voiddeleteColumns(intcolumnIndex, inttotalColumns, booleanupdateReference)
Deletes several columns.
voiddeleteRange(intstartRow, intstartColumn, intendRow, intendColumn, intshiftType)
Deletes a range of cells and shift cells according to the shift option.
voiddeleteRow(introwIndex)
Deletes a row.
booleandeleteRows(introwIndex, inttotalRows)
Deletes several rows.
booleandeleteRows(introwIndex, inttotalRows, booleanupdateReference)
Deletes multiple rows in the worksheet.
voiddispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
CellendCellInColumn(intstartRow, intendRow, shortstartColumn, shortendColumn)
Gets the last cell with maximum column index in this range.
CellendCellInColumn(shortcolumnIndex)
Gets the last cell in this column.
CellendCellInRow(introwIndex)
Gets the last cell in this row.
CellendCellInRow(intstartRow, intendRow, intstartColumn, intendColumn)
Gets the last cell with maximum row index in this range.
java.lang.Object[][]exportArray(intfirstRow, intfirstColumn, inttotalRows, inttotalColumns)
Exports data in the Cells collection to a two-dimension array object.
int[][]exportTypeArray(intfirstRow, intfirstColumn, inttotalRows, inttotalColumns)
Exports cell value type in the Cells collection to a two-dimension array object.
Cellfind(java.lang.Objectwhat, Cell previousCell, FindOptions findOptions)
Finds the cell containing with the input object.
CellfindFormula(java.lang.Stringformula, Cell previousCell)
Finds the cell with the input string.
CellfindFormulaContains(java.lang.Stringformula, Cell previousCell)
Finds the cell with formla which contains the input string.
CellfindNumber(doubleinputNumber, Cell previousCell)
Finds the cell with the input double.
CellfindNumber(intinputNumber, Cell previousCell)
Finds the cell with the input integer.
CellfindString(java.lang.StringinputString, Cell previousCell)
Finds the cell with the input string.
CellfindString(java.lang.StringinputString, Cell previousCell, booleanupDown)
Finds the cell with the input string.
CellfindString(java.lang.StringinputString, Cell previousCell, CellArea area)
Finds the cell with the input string in the specified area.
CellfindString(java.lang.StringinputString, Cell previousCell, CellArea area, booleanupDown)
Finds the cell with the input string in the specified area.
CellfindString(java.lang.StringinputString, Cell previousCell, FindOptions findOptions)
Finds the cell with the input string.
CellfindStringContains(java.lang.StringinputString, Cell previousCell)
Finds the cell containing with the input string.
CellfindStringContains(java.lang.StringinputString, Cell previousCell, booleanisCaseSensitive)
Finds the cell containing with the input string.
CellfindStringContains(java.lang.StringinputString, Cell previousCell, booleanisCaseSensitive, CellArea area)
Finds the cell containing with the input string.
CellfindStringEndsWith(java.lang.StringinputString, Cell previousCell)
Finds the cell ending with the input string.
CellfindStringStartsWith(java.lang.StringinputString, Cell previousCell)
Finds the cell starting with the input string.
CellgetCell(introw, intcolumn)
Gets the Cell element at the specified cell row index and column index.
StylegetCellStyle(introw, intcolumn)
Get the style of given cell.
ColumngetColumn(intcolumnIndex)
Gets the Column element or at the specified cell row index.
doublegetColumnWidth(intcolumn)
Gets the width of the specified column
doublegetColumnWidthInch(intcolumn)
Gets the width of the specified column, in units of inches.
intgetColumnWidthPixel(intcolumn)
Gets the width of the specified column, in units of pixel.
Cell[]getDependents(booleanisAll, introw, intcolumn)
Get all cells which refer to the specific cell.
intgetGroupedColumnOutlineLevel(intcolumnIndex)
Gets the outline level (zero-based) of the column.
intgetGroupedRowOutlineLevel(introwIndex)
Gets the outline level (zero-based) of the row.
intgetLastDataRow(intcolumn)
Gets the last row index of cell which contains data in the specified column.
intgetMaxGroupedColumnOutlineLevel()
Gets the max grouped column outline level (zero-based).
intgetMaxGroupedRowOutlineLevel()
Gets the max grouped row outline level (zero-based).
RowgetRow(introw)
Gets the Row element or at the specified cell row index.
java.util.IteratorgetRowEnumerator()
Gets the rows enumerator
doublegetRowHeight(introw)
Gets the height of a specified row.
doublegetRowHeightInch(introw)
Gets the height of a specified row in unit of inches.
intgetRowHeightPixel(introw)
Gets the height of a specified row in unit of pixel.
intgetViewColumnWidthPixel(intcolumn)
Get the width in different view type.
voidgroupColumns(intfirstIndex, intlastIndex)
Groups columns.
voidgroupColumns(intfirstIndex, intlastIndex, booleanisHidden)
Groups columns.
voidgroupRows(intfirstIndex, intlastIndex)
Groups rows.
voidgroupRows(intfirstIndex, intlastIndex, booleanisHidden)
Groups rows.
voidhideColumn(intcolumn)
Hides a column.
voidhideColumns(intcolumn, inttotalColumns)
Hide multiple columns.
voidhideGroupDetail(booleanisVertical, intindex)
Collapses the grouped rows/columns.
voidhideRow(introw)
Hides a row.
voidhideRows(introw, inttotalRows)
Hides multiple rows.
voidimportArray(double[]doubleArray, intfirstRow, intfirstColumn, booleanisVertical)
Imports an array of double into a worksheet.
voidimportArray(double[][]doubleArray, intfirstRow, intfirstColumn)
Imports a two-dimension array of double into a worksheet.
voidimportArray(int[]intArray, intfirstRow, intfirstColumn, booleanisVertical)
Imports an array of integer into a worksheet.
voidimportArray(int[][]intArray, intfirstRow, intfirstColumn)
Imports a two-dimension array of integer into a worksheet.
voidimportArray(java.lang.String[]stringArray, intfirstRow, intfirstColumn, booleanisVertical)
Imports an array of string into a worksheet.
voidimportArray(java.lang.String[][]stringArray, intfirstRow, intfirstColumn)
Imports a two-dimension array of string into a worksheet.
voidimportArrayList(java.util.ArrayListarrayList, intfirstRow, intfirstColumn, booleanisVertical)
Imports an arraylist of data into a worksheet.
voidimportCSV(java.io.InputStreamstream, TxtLoadOptions options, intfirstRow, intfirstColumn)
Import a CSV file to the cells.
voidimportCSV(java.io.InputStreamstream, java.lang.Stringspliter, booleanconvertNumericData, intfirstRow, intfirstColumn)
Import a CSV file to the cells.
voidimportCSV(java.lang.StringfileName, TxtLoadOptions options, intfirstRow, intfirstColumn)
Import a CSV file to the cells.
voidimportCSV(java.lang.StringfileName, java.lang.Stringspliter, booleanconvertNumericData, intfirstRow, intfirstColumn)
Import a CSV file to the cells.
intimportCustomObjects(java.util.Collectionlist, intfirstRow, intfirstColumn, ImportTableOptions options)
Imports custom objects.
intimportCustomObjects(java.util.Collectionlist, java.lang.String[]propertyNames, booleanisPropertyNameShown, intfirstRow, intfirstColumn, introwNumber, booleaninsertRows, java.lang.StringdateFormatString, booleanconvertStringToNumber)
Imports custom objects.
intimportData(ICellsDataTable table, intfirstRow, intfirstColumn, ImportTableOptions options)
Import data from custom data table.
voidimportFormulaArray(java.lang.String[]stringArray, intfirstRow, intfirstColumn, booleanisVertical)
Imports an array of formula into a worksheet.
voidimportObjectArray(java.lang.Object[]objArray, intfirstRow, intfirstColumn, booleanisVertical)
Imports an array of data into a worksheet.
voidimportObjectArray(java.lang.Object[]objArray, intfirstRow, intfirstColumn, booleanisVertical, intskip)
Imports an array of data into a worksheet.
intimportResultSet(java.sql.ResultSetrs, introwIndex, intcolumnIndex, booleanisFieldNameShown)
Imports data in a ResultSet object to the worksheet.
intimportResultSet(java.sql.ResultSetrs, introwIndex, intcolumnIndex, booleanisFieldNameShown, java.lang.StringcustomDateFormatString, booleanconvertStringToNumber)
Imports data in a ResultSet object to the worksheet.
intimportResultSet(java.sql.ResultSetrs, introwIndex, intcolumnIndex, ImportTableOptions options)
Imports data in a ResultSet object to the worksheet.
intimportResultSet(java.sql.ResultSetrs, introwIndex, intcolumnIndex, introwNum, intcolumnNum, booleanisFieldNameShown)
Imports data in a ResultSet object to the worksheet.
intimportResultSet(java.sql.ResultSetrs, introwIndex, intcolumnIndex, introwNum, intcolumnNum, booleanisFieldNameShown, java.lang.StringcustomDateFormatString, booleanconvertStringToNumber)
Imports data in a ResultSet object to the worksheet.
intimportResultSet(java.sql.ResultSetrs, java.lang.StringstartCell, booleanisFieldNameShown)
Imports data in a ResultSet object to the worksheet.
intimportResultSet(java.sql.ResultSetrs, java.lang.StringstartCell, ImportTableOptions options)
Imports data in a ResultSet object to the worksheet.
intimportResultSet(java.sql.ResultSetrs, java.lang.StringstartCell, introwNum, intcolumnNum, booleanisFieldNameShown)
Imports data in a ResultSet object to the worksheet.
voidimportTwoDimensionArray(java.lang.Object[][]objArray, intfirstRow, intfirstColumn)
Imports a two-dimension array of data into a worksheet.
voidimportTwoDimensionArray(java.lang.Object[][]objArray, intfirstRow, intfirstColumn, booleanconvertStringToNumber)
Imports a two-dimension array of data into a worksheet.
voidimportTwoDimensionArray(java.lang.Object[][]objArray, java.lang.Object[][]styles, intfirstRow, intfirstColumn, booleanconvertStringToNumber)
Imports a two-dimension array of data into a worksheet.
voidimportTwoDimensionArray(java.lang.Object[][]objArray, java.lang.Object[][]styles, intfirstRow, intfirstColumn, TxtLoadOptions opts)
Imports a two-dimension array of data into a worksheet.
voidinsertColumn(intcolumnIndex)
Inserts a new column into the worksheet.
voidinsertColumn(intcolumnIndex, booleanupdateReference)
Inserts a new column into the worksheet.
voidinsertColumns(intcolumnIndex, inttotalColumns)
Inserts some columns into the worksheet.
voidinsertColumns(intcolumnIndex, inttotalColumns, booleanupdateReference)
Inserts some columns into the worksheet.
voidinsertRange(CellArea area, intshiftType)
Inserts a range of cells and shift cells according to the shift option.
voidinsertRange(CellArea area, intshiftNumber, intshiftType)
Inserts a range of cells and shift cells according to the shift option.
voidinsertRange(CellArea area, intshiftNumber, intshiftType, booleanupdateReference)
Inserts a range of cells and shift cells according to the shift option.
voidinsertRow(introwIndex)
Inserts a new row into the worksheet.
voidinsertRows(introwIndex, inttotalRows)
Inserts multiple rows into the worksheet.
voidinsertRows(introwIndex, inttotalRows, booleanupdateReference)
Inserts multiple rows into the worksheet.
booleanisBlankColumn(intcolumnIndex)
Checks whether given column is blank(does not contain any data).
booleanisColumnHidden(intcolumnIndex)
Checks whether a column at given index is hidden.
booleanisDeletingRangeEnabled(intstartRow, intstartColumn, inttotalRows, inttotalColumns)
Check whether the range could be deleted.
booleanisRowHidden(introwIndex)
Checks whether a row at given index is hidden.
java.util.Iteratoriterator()
Gets the cells enumerator.
voidlinkToXmlMap(java.lang.StringmapName, introw, intcolumn, java.lang.Stringpath)
Link to a xml map.
voidmerge(intfirstRow, intfirstColumn, inttotalRows, inttotalColumns)
Merges a specified range of cells into a single cell.
voidmerge(intfirstRow, intfirstColumn, inttotalRows, inttotalColumns, booleanmergeConflict)
Merges a specified range of cells into a single cell.
voidmerge(intfirstRow, intfirstColumn, inttotalRows, inttotalColumns, booleancheckConflict, booleanmergeConflict)
Merges a specified range of cells into a single cell.
voidmoveRange(CellArea sourceArea, intdestRow, intdestColumn)
Moves the range.
voidremoveDuplicates(intstartRow, intstartColumn, intendRow, intendColumn)
Remove duplicate values in the range.
voidremoveFormulas()
Removes all formula and replaces with the value of the formula.
voidsetColumnWidth(intcolumn, doublewidth)
Sets the width of the specified column.
voidsetColumnWidthInch(intcolumn, doubleinches)
Sets column width in unit of inches.
voidsetColumnWidthPixel(intcolumn, intpixel)
Sets column width in unit of pixels.
voidsetRowHeight(introw, doubleheight)
Sets the height of the specified row.
voidsetRowHeightInch(introw, doubleinches)
Sets row height in unit of inches.
voidsetRowHeightPixel(introw, intpixels)
Sets row height in unit of pixels.
voidshowGroupDetail(booleanisVertical, intindex)
Uncollapses the grouped rows/columns.
voidsubtotal(CellArea ca, intgroupBy, intfunction, int[]totalList)
Creates subtotals for the range.
voidsubtotal(CellArea ca, intgroupBy, intfunction, int[]totalList, booleanreplace, booleanpageBreaks, booleansummaryBelowData)
Creates subtotals for the range.
voidtextToColumns(introw, intcolumn, inttotalRows, TxtLoadOptions options)
Splits the text in the column to columns.
voidungroupColumns(intfirstIndex, intlastIndex)
Ungroups columns.
voidungroupRows(intfirstIndex, intlastIndex)
Ungroups rows.
voidungroupRows(intfirstIndex, intlastIndex, booleanisAll)
Ungroups rows.
voidunhideColumn(intcolumn, doublewidth)
Unhides a column
voidunhideColumns(intcolumn, inttotlaColumns, doublewidth)
Unhide multiple columns.
voidunhideRow(introw, doubleheight)
Unhides a row.
voidunhideRows(introw, inttotalRows, doubleheight)
Unhides the hidden rows.
voidunMerge(intfirstRow, intfirstColumn, inttotalRows, inttotalColumns)
Unmerges a specified range of merged cells.
 

    • Property Getters/Setters Detail

      • getCount

        public int getCount()
        
        Gets the number of cells.
      • getRows

        public RowCollection getRows()
        
        Gets the collection of Row objects that represents the individual rows in this worksheet.
      • getMergedCells

        public java.util.ArrayList getMergedCells()
        
        Gets the collection of merged cells. In this collection, each item is a CellArea structure which represents an area of merged cells.
      • getMultiThreadReading/setMultiThreadReading

        public boolean getMultiThreadReading() / public void setMultiThreadReading(boolean 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.
      • getMemorySetting/setMemorySetting

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

        public Style getStyle() / public void setStyle(Style value)
        
        Gets and sets the default style.
      • getStandardWidthInch/setStandardWidthInch

        public double getStandardWidthInch() / public void setStandardWidthInch(double value)
        
        Gets or sets the default column width in the worksheet, in unit of inches.
      • getStandardWidthPixels/setStandardWidthPixels

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

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

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

        public int getStandardHeightPixels() / public void setStandardHeightPixels(int value)
        
        Gets or sets the default row height in this worksheet, in unit of pixels.
      • getPreserveString/setPreserveString

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

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

        public int getMaxRow()
        
        Maximum row index of cell which contains data or style. Return -1 if there is no cell whiche contains data or style in the worksheet.
      • getMinColumn

        public int getMinColumn()
        
        Minimum column index of cell which contains data or style.
      • getMaxColumn

        public int getMaxColumn()
        
        Maximum column index of cell which contains data or style. Return -1 if ther is not cell.
      • getMinDataRow

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

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

        public int getMinDataColumn()
        
        Minimum column index of cell which contains data.
      • getMaxDataColumn

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

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

        public boolean isDefaultRowHidden() / public void setDefaultRowHidden(boolean value)
        
        Indicates whether the row is defaultly hidden.
      • getColumns

        public ColumnCollection getColumns()
        
        Gets the collection of Column objects that represents the individual columns in this worksheet.
      • getRanges

        public RangeCollection getRanges()
        
        Gets the collection of Range objects created at run time.
      • getEnd

        public Cell getEnd()
        
        Gets the last cell in this worksheet. NOTE: This member is now obsolete. Instead, please use Cells.LastCell property. This property will be removed 12 months later since December 2015. Aspose apologizes for any inconvenience you may have experienced.
      • getLastCell

        public Cell getLastCell()
        
        Gets the last cell in this worksheet.
      • getMaxDisplayRange

        public Range getMaxDisplayRange()
        
        Gets the max range which includes data, merged cells and shapes.
      • getStart

        public Cell getStart()
        
        Gets the first cell in this worksheet. NOTE: This member is now obsolete. Instead, please use Cells.FirstCell property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
      • getFirstCell

        public Cell getFirstCell()
        
        Gets the first cell in this worksheet.
      • get

        public Cell get(int 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.
        Parameters:
        index - The zero based index of the element.
      • get

        public Cell get(int row, int 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:

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

        public Cell get(java.lang.String 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:

        Cells cells = excel.getWorksheets().get(0).getCells();
        Cell cell = cells.get("A1");    //Gets the cell at "A1"
    • Method Detail

      • findFormula

        public Cell findFormula(java.lang.String formula, Cell previousCell)
        Finds the cell with the input string. This method is supported in Standard and above versions of Aspose.Cells.
        Parameters:
        formula - The formula to search for.
        previousCell - Previous cell with the same formula. This parameter can be set to null if searching from the start.
        Returns:
        Cell object.
      • findFormulaContains

        public Cell findFormulaContains(java.lang.String formula, Cell previousCell)
        Finds the cell with formla which contains the input string. This method is supported in Standard and above versions of Aspose.Cells.
        Parameters:
        formula - The formula to search for.
        previousCell - Previous cell with the same formula. This parameter can be set to null if searching from the start.
        Returns:
        Cell object.
      • findString

        public Cell findString(java.lang.String inputString, Cell previousCell)
        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. This member will be removed 12 months later since May 2012. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        inputString - The string to search for.
        previousCell - Previous cell with the same string. This parameter can be set to null if searching from the start.
        Returns:
        Cell object.
      • findString

        public Cell findString(java.lang.String inputString, Cell previousCell, CellArea area)
        Finds the cell with the input string in the specified area. Returns null (Nothing) if no cell is found. NOTE: This member is now obsolete. Instead, please use Cells.Find(object,Cell,FindOptions) method. This member will be removed 12 months later since May 2012. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        inputString - The string to search for.
        previousCell - Previous cell with the same string. This parameter can be set to null if searching from the start.
        area - Searched area.
        Returns:
        Cell object.
      • findString

        public Cell findString(java.lang.String inputString, Cell previousCell, CellArea area, boolean upDown)
        Finds the cell with the input string in the specified area. Returns null (Nothing) if no cell is found. NOTE: This member is now obsolete. Instead, please use Cells.Find(object,Cell,FindOptions) method. This member will be removed 12 months later since May 2012. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        inputString - The string to search for.
        previousCell - Previous cell with the same string. This parameter can be set to null if searching from the start.
        area - Searched area.
        upDown - Search order. True: Up. False: Down.
        Returns:
        Cell object.
      • findString

        public Cell findString(java.lang.String inputString, Cell previousCell, boolean upDown)
        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. This member will be removed 12 months later since May 2012. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        inputString - The string to search for.
        previousCell - Previous cell with the same string. This parameter can be set to null if searching from the start.
        upDown - Search order. True: Up. False: Down.
        Returns:
        Cell object.
      • findString

        public Cell findString(java.lang.String inputString, Cell previousCell, FindOptions findOptions)
        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. This member will be removed 12 months later since May 2012. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        inputString - The string to search for.
        previousCell - Previous cell with the same string. This parameter can be set to null if searching from the start.
        findOptions - Sets the find options.
        Returns:
        Cell object.
      • findStringStartsWith

        public Cell findStringStartsWith(java.lang.String inputString, Cell previousCell)
        Finds the cell starting 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. This member will be removed 12 months later since May 2012. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        inputString - The string to search for.
        previousCell - Previous cell with the same string. This parameter can be set to null if searching from the start.
        Returns:
        Cell object.
      • findStringEndsWith

        public Cell findStringEndsWith(java.lang.String inputString, Cell previousCell)
        Finds the cell ending 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. This member will be removed 12 months later since May 2012. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        inputString - The string to search for.
        previousCell - Previous cell with the same string. This parameter can be set to null if searching from the start.
        Returns:
        Cell object.
      • findStringContains

        public Cell findStringContains(java.lang.String inputString, Cell previousCell)
        Finds the cell containing 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. This member will be removed 12 months later since May 2012. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        inputString - The string to search for.
        previousCell - Previous cell with the same string. This parameter can be set to null if searching from the start.
        Returns:
        Cell object.
      • findStringContains

        public Cell findStringContains(java.lang.String inputString, Cell previousCell, boolean isCaseSensitive, CellArea area)
        Finds the cell containing 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. This member will be removed 12 months later since May 2012. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        inputString - The string to search for.
        previousCell - Previous cell with the same string. This parameter can be set to null if searching from the start.
        isCaseSensitive - Indicates if the searched string is case sensitive.
        area - Searched area.
        Returns:
        Cell object.
      • findStringContains

        public Cell findStringContains(java.lang.String inputString, Cell previousCell, boolean isCaseSensitive)
        Finds the cell containing 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. This member will be removed 12 months later since May 2012. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        inputString - The string to search for.
        previousCell - Previous cell with the same string. This parameter can be set to null if searching from the start.
        isCaseSensitive - Indicates if the searched string is case sensitive.
        Returns:
        Cell object.
      • findNumber

        public Cell findNumber(int inputNumber, Cell previousCell)
        Finds the cell with the input integer. Returns null (Nothing) if no cell is found. NOTE: This member is now obsolete. Instead, please use Cells.Find(object,Cell,FindOptions) method. This member will be removed 12 months later since May 2012. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        inputNumber - The integer to search for.
        previousCell - Previous cell with the same integer. This parameter can be set to null if searching from the start.
        Returns:
        Cell object.
      • findNumber

        public Cell findNumber(double inputNumber, Cell previousCell)
        Finds the cell with the input double. Returns null (Nothing) if no cell is found. NOTE: This member is now obsolete. Instead, please use Cells.Find(object,Cell,FindOptions) method. This member will be removed 12 months later since May 2012. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        inputNumber - The double to search for.
        previousCell - Previous cell with the same double. This parameter can be set to null if searching from the start.
        Returns:
        Cell object.
      • find

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

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

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

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

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

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

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

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

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

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

        public java.lang.Object[][] exportArray(int firstRow, int firstColumn, int totalRows, int totalColumns)
        Exports data in the Cells collection to a two-dimension array object.
        Parameters:
        firstRow - The row number of the first cell to export out.
        firstColumn - The column number of the first cell to export out.
        totalRows - Number of rows to be exported
        totalColumns - Number of columns to be exported
        Returns:
        Exported cell value array object.
      • exportTypeArray

        public int[][] exportTypeArray(int firstRow, int firstColumn, int totalRows, int totalColumns)
        Exports cell value type in the Cells collection to a two-dimension array object.
        Parameters:
        firstRow - The row number of the first cell to export out.
        firstColumn - The column number of the first cell to export out.
        totalRows - Number of rows to be exported.
        totalColumns - Number of columns to be exported.
        Returns:
        Exported CellValuetype array object.
      • importCustomObjects

        public int importCustomObjects(java.util.Collection list, java.lang.String[] propertyNames, boolean isPropertyNameShown, int firstRow, int firstColumn, int rowNumber, boolean insertRows, java.lang.String dateFormatString, boolean convertStringToNumber)
        Imports custom objects. The custom objects should be the same type.
        Parameters:
        list - The custom object
        propertyNames - The property names.If it is null,we will import all properties of the object.
        isPropertyNameShown - Indicates whether the property name will be imported to the first row.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
        rowNumber - Number of rows to be imported.
        insertRows - Indicates whether extra rows are added to fit data.
        dateFormatString - Date format string for cells.
        convertStringToNumber - Indicates if this method will try to convert string to number.
        Returns:
        Total number of rows imported.
      • importCustomObjects

        public int importCustomObjects(java.util.Collection list, int firstRow, int firstColumn, ImportTableOptions options)
        Imports custom objects. The custom objects should be the same type.
        Parameters:
        list - The custom object
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
        options - The import options.
        Returns:
        Total number of rows imported.
      • subtotal

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

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

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

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

        public void convertStringToNumericValue()
        Converts string data in cells to numeric value if possible.
      • getDependents

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

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

        public int importResultSet(java.sql.ResultSet rs, java.lang.String startCell, ImportTableOptions options)
                           throws java.lang.Exception
        Imports data in a ResultSet object to the worksheet.
        Parameters:
        rs - the ResultSet object to import from.
        startCell - name of start cell to insert the resultset, such as "A1".
        options - The import options
        Returns:
        how many rows actually imported.
      • importResultSet

        public int importResultSet(java.sql.ResultSet rs, int rowIndex, int columnIndex, ImportTableOptions options)
                           throws java.lang.Exception
        Imports data in a ResultSet object to the worksheet.
        Parameters:
        rs - the ResultSet object to import from.
        rowIndex - start row index in the worksheet.
        columnIndex - start column index in the worksheet.
        options - The import options
        Returns:
        how many rows actually imported.
      • importResultSet

        public int importResultSet(java.sql.ResultSet rs, int rowIndex, int columnIndex, int rowNum, int columnNum, boolean isFieldNameShown)
                           throws java.lang.Exception
        Imports data in a ResultSet object to the worksheet.
        Parameters:
        rs - the ResultSet object to import from.
        rowIndex - start row index in the worksheet.
        columnIndex - start column index in the worksheet.
        rowNum - number of rows to import. -1 to import all records in given resultset.
        columnNum - number of columns to import. -1 to import all columns in given resultset.
        isFieldNameShown - Indicates whether the field name of the resultset will be imported to the first row.
        Returns:
        how many rows actually imported.
      • importResultSet

        public int importResultSet(java.sql.ResultSet rs, java.lang.String startCell, int rowNum, int columnNum, boolean isFieldNameShown)
                           throws java.lang.Exception
        Imports data in a ResultSet object to the worksheet.
        Parameters:
        rs - the ResultSet object to import from.
        startCell - name of start cell to insert the resultset, such as "A1".
        rowNum - number of rows to import. -1 to import all records in given resultset.
        columnNum - number of columns to import. -1 to import all columns in given resultset.
        isFieldNameShown - Indicates whether the field name of the resultset will be imported to the first row.
        Returns:
        how many rows actually imported.
      • importResultSet

        public int importResultSet(java.sql.ResultSet rs, int rowIndex, int columnIndex, boolean isFieldNameShown)
                           throws java.lang.Exception
        Imports data in a ResultSet object to the worksheet.
        Parameters:
        rs - the ResultSet object to import from.
        rowIndex - start row index in the worksheet.
        columnIndex - start column index in the worksheet.
        isFieldNameShown - Indicates whether the field name of the resultset will be imported to the first row.
        Returns:
        how many rows actually imported.
      • importResultSet

        public int importResultSet(java.sql.ResultSet rs, java.lang.String startCell, boolean isFieldNameShown)
                           throws java.lang.Exception
        Imports data in a ResultSet object to the worksheet.
        Parameters:
        rs - the ResultSet object to import from.
        startCell - name of start cell to insert the resultset, such as "A1".
        isFieldNameShown - Indicates whether the field name of the resultset will be imported to the first row.
        Returns:
        how many rows actually imported.
      • importResultSet

        public int importResultSet(java.sql.ResultSet rs, int rowIndex, int columnIndex, int rowNum, int columnNum, boolean isFieldNameShown, java.lang.String customDateFormatString, boolean convertStringToNumber)
                           throws java.lang.Exception
        Imports data in a ResultSet object to the worksheet.
        Parameters:
        rs - the ResultSet object to import from.
        rowIndex - start row index in the worksheet.
        columnIndex - start column index in the worksheet.
        rowNum - number of rows to import. -1 to import all records in given resultset.
        columnNum - number of columns to import. -1 to import all columns in given resultset.
        isFieldNameShown - Indicates whether the field name of the resultset will be imported to the first row.
        customDateFormatString - Date format string for cells which contain date value.
        convertStringToNumber - Indicates if this method will try to convert string to number.
        Returns:
        how many rows actually imported.
      • importResultSet

        public int importResultSet(java.sql.ResultSet rs, int rowIndex, int columnIndex, boolean isFieldNameShown, java.lang.String customDateFormatString, boolean convertStringToNumber)
                           throws java.lang.Exception
        Imports data in a ResultSet object to the worksheet.
        Parameters:
        rs - the ResultSet object to import from.
        rowIndex - start row index in the worksheet.
        columnIndex - start column index in the worksheet.
        isFieldNameShown - Indicates whether the field name of the resultset will be imported to the first row.
        customDateFormatString - Date format string for cells which contain date value.
        convertStringToNumber - Indicates if this method will try to convert string to number.
        Returns:
        how many rows actually imported.
      • importArray

        public void importArray(double[] doubleArray, int firstRow, int firstColumn, boolean isVertical)
        Imports an array of double into a worksheet.
        Parameters:
        doubleArray - Double array.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
        isVertical - Specifies to import data vertically or horizontally.
      • textToColumns

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

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

        public void importCSV(java.io.InputStream stream, java.lang.String spliter, boolean convertNumericData, int firstRow, int firstColumn)
                      throws java.lang.Exception
        Import a CSV file to the cells.
        Parameters:
        stream - The CSV file stream.
        spliter - The spliter
        convertNumericData - Whether the string in text file is converted to numeric data.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
      • importCSV

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

        public void importCSV(java.io.InputStream stream, TxtLoadOptions options, int firstRow, int firstColumn)
                      throws java.lang.Exception
        Import a CSV file to the cells.
        Parameters:
        stream - The CSV file stream.
        options - The load options for reading text file
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
      • merge

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

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

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

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

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

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

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

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

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

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

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

        public double getRowHeight(int row)
        Gets the height of a specified row.
        Parameters:
        row - Row index
        Returns:
        Height of row
      • hideColumn

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

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

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

        public void unhideColumns(int column, int totlaColumns, double width)
        Unhide multiple columns. Only applies the column width to the hidden columns.
        Parameters:
        column - Column index.
        totlaColumns - Column number
        width - Column width.
      • getRowHeightPixel

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

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

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

        public void setColumnWidthInch(int column, double inches)
        Sets column width in unit of inches.
        Parameters:
        column - Column index.
        inches - Number of inches.
      • setColumnWidth

        public void setColumnWidth(int column, double width)
        Sets the width of the specified column. To hide a column, sets column width to zero.
        Parameters:
        column - Column index.
        width - Width of column.Column width must be between 0 and 255.
      • getViewColumnWidthPixel

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

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

        public double getColumnWidthInch(int column)
        Gets the width of the specified column, in units of inches.
        Parameters:
        column - Column index
        Returns:
        Width of column
      • getColumnWidth

        public double getColumnWidth(int column)
        Gets the width of the specified column
        Parameters:
        column - Column index
        Returns:
        Width of column
      • getLastDataRow

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public void showGroupDetail(boolean isVertical, int index)
        Uncollapses the grouped rows/columns.
        Parameters:
        isVertical - True, uncollapse the grouped rows.
        index - The row/column index
      • hideGroupDetail

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

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

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

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

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

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

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

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

        public void deleteColumn(int columnIndex, boolean updateReference)
        Deletes a column.
        Parameters:
        columnIndex - Column index.
        updateReference - Indicates if update references in other worksheets.
      • deleteColumn

        public void deleteColumn(int columnIndex)
        Deletes a column.
        Parameters:
        columnIndex - Column index.
      • deleteColumns

        public void deleteColumns(int columnIndex, int totalColumns, boolean updateReference)
        Deletes several columns.
        Parameters:
        columnIndex - Column index.
        totalColumns - Number of columns to be deleted.
        updateReference - Indicates if update references in other worksheets.
      • isDeletingRangeEnabled

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

        public boolean deleteRows(int rowIndex, int 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:
        rowIndex - The first row index to be deleted.
        totalRows - Number of rows to be deleted.
      • deleteRow

        public void deleteRow(int rowIndex)
        Deletes a row.
        Parameters:
        rowIndex - Row index.
      • deleteRows

        public boolean deleteRows(int rowIndex, int totalRows, boolean updateReference)
        Deletes multiple rows in the worksheet.
        Parameters:
        rowIndex - Row index.
        totalRows - Number of rows to be deleted.
        updateReference - Indicates if update references in other worksheets.
        Returns:
      • deleteBlankColumns

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

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

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

        public void deleteBlankRows()
        Delete all blank rows which do not contain any data.
      • deleteBlankRows

        public void deleteBlankRows(DeleteOptions options)
        Delete all blank rows which do not contain any data.
        Parameters:
        options - The options of deleting range.
      • insertColumns

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

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

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

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

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

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

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

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

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

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

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

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

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

        public void linkToXmlMap(java.lang.String mapName, int row, int column, java.lang.String path)
                         throws java.lang.Exception
        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 - name of xml map
        row - row of the destination cell
        column - column of the destination cell
        path - path of xml element in xml map
      • dispose

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

        public java.util.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

        public java.util.Iterator getRowEnumerator()
        Gets the rows enumerator
        Returns:
        The rows enuerator.
      • getCell

        public Cell getCell(int row, int column)
        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:
        row - Row index
        column - Column index
        Returns:
        Return Cell object.
      • getRow

        public Row getRow(int 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.
        Parameters:
        row - Row index
        Returns:
        return the row object.
      • getColumn

        public Column getColumn(int columnIndex)
        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.
        Parameters:
        columnIndex - The column index.
        Returns:
      • checkCell

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

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

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

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

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

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

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

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

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

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

        public void clear()
        Clears all cell and row objects.
      • importData

        public int importData(ICellsDataTable table, int firstRow, int firstColumn, ImportTableOptions options)
        Import data from custom data table.
        Parameters:
        table - The custom data table.
        firstRow - First row index.
        firstColumn - First column index.
        options - The import options
        Returns:
      • importTwoDimensionArray

        public void importTwoDimensionArray(java.lang.Object[][] objArray, int firstRow, int firstColumn)
        Imports a two-dimension array of data into a worksheet.
        Parameters:
        objArray - Two-dimension data array.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
      • importTwoDimensionArray

        public void importTwoDimensionArray(java.lang.Object[][] objArray, int firstRow, int firstColumn, boolean convertStringToNumber)
        Imports a two-dimension array of data into a worksheet.
        Parameters:
        objArray - Two-dimension data array.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
        convertStringToNumber - Indicates if this method will try to convert string to number.
      • importTwoDimensionArray

        public void importTwoDimensionArray(java.lang.Object[][] objArray, java.lang.Object[][] styles, int firstRow, int firstColumn, boolean convertStringToNumber)
        Imports a two-dimension array of data into a worksheet.
        Parameters:
        objArray - Two-dimension data array.
        styles - Two-dimension data style.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
        convertStringToNumber - Indicates if this method will try to convert string to number.
      • importTwoDimensionArray

        public void importTwoDimensionArray(java.lang.Object[][] objArray, java.lang.Object[][] styles, int firstRow, int firstColumn, TxtLoadOptions opts)
        Imports a two-dimension array of data into a worksheet.
        Parameters:
        objArray - Two-dimension data array.
        styles - Two-dimension data style.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
        opts - Options for converting string values
      • importObjectArray

        public void importObjectArray(java.lang.Object[] objArray, int firstRow, int firstColumn, boolean isVertical)
        Imports an array of data into a worksheet.
        Parameters:
        objArray - Data array.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
        isVertical - Specifies to import data vertically or horizontally.
      • importArrayList

        public void importArrayList(java.util.ArrayList arrayList, int firstRow, int firstColumn, boolean isVertical)
        Imports an arraylist of data into a worksheet.
        Parameters:
        arrayList - Data arraylist.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
        isVertical - Specifies to import data vertically or horizontally.
      • importObjectArray

        public void importObjectArray(java.lang.Object[] objArray, int firstRow, int firstColumn, boolean isVertical, int skip)
        Imports an array of data into a worksheet.
        Parameters:
        objArray - Data array.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
        isVertical - Specifies to import data vertically or horizontally.
        skip - Skipped number of rows or columns.
      • importArray

        public void importArray(java.lang.String[][] stringArray, int firstRow, int firstColumn)
        Imports a two-dimension array of string into a worksheet.
        Parameters:
        stringArray - Two-dimension string array.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
      • importFormulaArray

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

        public void importArray(java.lang.String[] stringArray, int firstRow, int firstColumn, boolean isVertical)
        Imports an array of string into a worksheet.
        Parameters:
        stringArray - String array.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
        isVertical - Specifies to import data vertically or horizontally.
      • importArray

        public void importArray(int[][] intArray, int firstRow, int firstColumn)
        Imports a two-dimension array of integer into a worksheet.
        Parameters:
        intArray - Two-dimension integer array.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
      • importArray

        public void importArray(int[] intArray, int firstRow, int firstColumn, boolean isVertical)
        Imports an array of integer into a worksheet.
        Parameters:
        intArray - Integer array.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.
        isVertical - Specifies to import data vertically or horizontally.
      • importArray

        public void importArray(double[][] doubleArray, int firstRow, int firstColumn)
        Imports a two-dimension array of double into a worksheet.
        Parameters:
        doubleArray - Two-dimension double array.
        firstRow - The row number of the first cell to import in.
        firstColumn - The column number of the first cell to import in.