com.aspose.cells
Class Cells

java.lang.Object
    com.aspose.cells.Cells

All Implemented Interfaces:

java.lang.Iterable

public class Cells 
extends java.lang.Object

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);
   
   //Put values to cells
   cells.get(0, 0).putValue(true);
   cells.get(0, 1).putValue(1);
   cells.get(0, 2).putValue("abc");

//Export data
Object[][] arr = cells.exportArray(0, 0, 10, 10);

public OdsCellFieldCollection getOdsCellFields()

Gets the list of fields of ods.

public int getCount()

Gets the total count of instantiated Cell objects.

public long getCountLarge()

Gets the total count of instantiated Cell objects.

public RowCollection getRows()

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

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.

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

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.

public Style getStyle() / public void setStyle(Style value)

Gets and sets the default style.

public double getStandardWidthInch() / public void setStandardWidthInch(double value)

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

public int getStandardWidthPixels() / public void setStandardWidthPixels(int value)

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

public double getStandardWidth() / public void setStandardWidth(double value)

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

public double getStandardHeight() / public void setStandardHeight(double value)

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

public int getStandardHeightPixels() / public void setStandardHeightPixels(int value)

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

public double getStandardHeightInch() / public void setStandardHeightInch(double value)

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

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.

public int getMinRow()

Minimum row index of cell which contains data or style.

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

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

public int getMaxColumn()

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

Return -1 if there is no cell.

public int getMinDataRow()

Minimum row index of cell which contains data.

public int getMaxDataRow()

Maximum row index of cell which contains data.

Return -1 if there is no cell which contains data.

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

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

public boolean isDefaultRowHeightMatched() / public void setDefaultRowHeightMatched(boolean value)

Indicates that row height and default font height matches

public boolean isDefaultRowHidden() / public void setDefaultRowHidden(boolean value)

Indicates whether the row is default hidden.

public ColumnCollection getColumns()

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

public RangeCollection getRanges()

Gets the collection of Range objects created at run time.

public Cell getLastCell()

Gets the last cell in this worksheet.

Returns null if there is no data in the worksheet.

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

public Cell getFirstCell()

Gets the first cell in this worksheet.

Returns null if there is no data in the worksheet.

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.

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:

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

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:

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

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

public Cell findFormula(java.lang.String formula, 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 with LookInType as LookInType.OnlyFormulas and LookAtType as LookAtType.EntireContent. This member will be removed 12 months later since November 2018. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

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.

public Cell findFormulaContains(java.lang.String formula, Cell previousCell)

Finds the cell with formula which contains the input string.

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

Parameters:

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.

public Cell find(java.lang.Object what, Cell previousCell)

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.

Returns:

Cell object.

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.

public Cell endCellInRow(int rowIndex)

Gets the last cell in this row.

Parameters:

rowIndex - Row index.

Returns:

Cell object.

public Cell endCellInColumn(short columnIndex)

Gets the last cell in this column.

Parameters:

columnIndex - Column index.

Returns:

Cell object.

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.

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.

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.

public void insertCutCells(Range cutRange, int row, int column, int shiftType)
                   throws java.lang.Exception

Insert cut range.

Parameters:

cutRange - The cut range.

row - The row.

column - The column.

shiftType - A ShiftType value. The shift type .

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.

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.

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.

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.

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.

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.

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)
                       throws java.lang.Exception

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.

public int importCustomObjects(java.util.Collection list, int firstRow, int firstColumn, ImportTableOptions options)
                       throws java.lang.Exception

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.

public SubtotalSetting retrieveSubtotalSetting(CellArea ca)

Retrieves subtotals setting of the range.

Parameters:

ca - The range

Returns:

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.

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 summary below data.

public void removeFormulas()

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

public void removeDuplicates()
                     throws java.lang.Exception

Removes duplicate rows in the sheet.

public void removeDuplicates(int startRow, int startColumn, int endRow, int endColumn)
                     throws java.lang.Exception

Removes duplicate values in the range.

Parameters:

startRow - The start row.

startColumn - The start column

endRow - The end row index.

endColumn - The end column index.

public void removeDuplicates(int startRow, int startColumn, int endRow, int endColumn, boolean hasHeaders, int[] columnOffsets)
                     throws java.lang.Exception

Removes duplicate data of the range.

Parameters:

startRow - The start row.

startColumn - The start column

endRow - The end row index.

endColumn - The end column index.

hasHeaders - Indicates whether the range contains headers.

columnOffsets - The column offsets.

public void convertStringToNumericValue()

Converts string data in cells to numeric value if possible.

public com.aspose.cells.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:

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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)

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.

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.

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)

public void clearMergedCells()

Clears all merged ranges.

public void hideRow(int row)

Hides a row.

Parameters:

row - Row index.

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.

public void hideRows(int row, int totalRows)

Hides multiple rows.

Parameters:

row - The row index.

totalRows - The row number.

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.

public void setRowHeightPixel(int row, int pixels)

Sets row height in unit of pixels.

Parameters:

row - Row index.

pixels - Number of pixels.

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.

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.

public double getRowOriginalHeightPoint(int row)

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

Parameters:

row - The row index.

Returns:

public void hideColumn(int column)

Hides a column.

Parameters:

column - Column index.

public void unhideColumn(int column, double width)

Unhides a column

Parameters:

column - Column index.

width - Column width.

public void hideColumns(int column, int totalColumns)

Hide multiple columns.

Parameters:

column - Column index.

totalColumns - Column number.

public void unhideColumns(int column, int totalColumns, double width)

Unhide multiple columns.

Only applies the column width to the hidden columns.

Parameters:

column - Column index.

totalColumns - Column number

width - Column width.

public double getRowHeight(int row)

Gets the height of a specified row.

Parameters:

row - Row index

Returns:

Height of row

public double getViewRowHeight(int row)

Gets the height of a specified row.

Parameters:

row - Row index

Returns:

Height of row

public int getRowHeightPixel(int row)

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

Parameters:

row - Row index

Returns:

Height of row

public double getRowHeightInch(int row)

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

Parameters:

row - Row index

Returns:

Height of row

public double getViewRowHeightInch(int row)

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

Parameters:

row - Row index

Returns:

Height of row

public void setColumnWidthPixel(int column, int pixels)

Sets column width in unit of pixels in normal view.

Parameters:

column - Column index.

pixels - Number of pixels.

public void setColumnWidthInch(int column, double inches)

Sets column width in unit of inches in normal view.

Parameters:

column - Column index.

inches - Number of inches.

public void setColumnWidth(int column, double width)

Sets the width of the specified column in normal view.

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.

public int getColumnWidthPixel(int column)

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

Parameters:

column - Column index

Returns:

Width of column in normal view.

public double getColumnWidthInch(int column)

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

Parameters:

column - Column index

Returns:

Width of column

public double getColumnWidth(int column)

Gets the width of the specified column in normal view

Parameters:

column - Column index

Returns:

Width of column

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

public void setViewColumnWidthPixel(int column, int 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 - The column index.

pixels - The width in unit of pixels.

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.

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.

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.

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.

public void copyColumns(Cells sourceCells0, int sourceColumnIndex, int destinationColumnIndex, int columnNumber, PasteOptions pasteOptions)
                throws java.lang.Exception

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.

pasteOptions - the options of pasting.

public void copyColumn(Cells sourceCells, int sourceColumnIndex, int destinationColumnIndex)
               throws java.lang.Exception

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.

public void copyColumns(Cells sourceCells0, int sourceColumnIndex, int destinationColumnIndex, int columnNumber)
                throws java.lang.Exception

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.

public void copyColumns(Cells sourceCells, int sourceColumnIndex, int sourceTotalColumns, int destinationColumnIndex, int destinationTotalColumns)
                throws java.lang.Exception

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.

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.

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.

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.

public void copyRows(Cells sourceCells0, int sourceRowIndex, int destinationRowIndex, int rowNumber, CopyOptions copyOptions, PasteOptions pasteOptions)
             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.

pasteOptions - the options of pasting.

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.

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

public int getMaxGroupedColumnOutlineLevel()

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

Returns:

The max grouped column outline level (zero-based)

public int getMaxGroupedRowOutlineLevel()

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

Returns:

The max grouped row outline level (zero-based)

public void showGroupDetail(boolean isVertical, int index)

Expands the grouped rows/columns.

Parameters:

isVertical - True, expands the grouped rows.

index - The row/column index

public void hideGroupDetail(boolean isVertical, int index)

Collapses the grouped rows/columns.

Parameters:

isVertical - True, collapse the grouped rows.

index - The row/column index

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.

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.

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.

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 outer group info.

public void ungroupRows(int firstIndex, int lastIndex)

Ungroups rows.

Only removes outer group info.

Parameters:

firstIndex - The first row index to be ungrouped.

lastIndex - The last row index to be ungrouped.

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.

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.

public void deleteColumn(int columnIndex, boolean updateReference)

Deletes a column.

Parameters:

columnIndex - Column index.

updateReference - Indicates if update references in other worksheets.

public void deleteColumn(int columnIndex)

Deletes a column.

Parameters:

columnIndex - Column index.

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.

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 index of the range.

totalRows - The number of the rows in the range.

totalColumns - The number of the columns in the range.

Returns:

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.

public void deleteRow(int rowIndex)

Deletes a row.

Parameters:

rowIndex - Row index.

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:

public void deleteBlankColumns()

Delete all blank columns which do not contain any data.

public void deleteBlankColumns(DeleteOptions options)

Delete all blank columns which do not contain any data.

Parameters:

options - The options of deleting range.

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

public void deleteBlankRows()

Delete all blank rows which do not contain any data.

public void deleteBlankRows(DeleteOptions options)

Delete all blank rows which do not contain any data.

Parameters:

options - The options of deleting range.

public void insertColumns(int columnIndex, int totalColumns)

Inserts some columns into the worksheet.

Parameters:

columnIndex - Column index.

totalColumns - The number of columns.

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.

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.

public void insertColumn(int columnIndex)

Inserts a new column into the worksheet.

Parameters:

columnIndex - Column index.

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.

public void insertRows(int rowIndex, int totalRows, InsertOptions options)

Inserts multiple rows into the worksheet.

Parameters:

rowIndex - Row index.

totalRows - Number of rows to be inserted.

options - Indicates if references in other worksheets will be updated.

public void insertRows(int rowIndex, int totalRows)

Inserts multiple rows into the worksheet.

Parameters:

rowIndex - Row index.

totalRows - Number of rows to be inserted.

public void insertRow(int rowIndex)

Inserts a new row into the worksheet.

Parameters:

rowIndex - Row index.

public void clearRange(CellArea range)

Clears contents and formatting of a range.

Parameters:

range - Range to be cleared.

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.

public void clearContents(CellArea range)

Clears contents of a range.

Parameters:

range - Range to be cleared.

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.

public void clearFormats(CellArea range)

Clears formatting of a range.

Parameters:

range - Range to be cleared.

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.

public void dispose()

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

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

Example:

Workbook workbook = new Workbook("template.xlsx");
   Cells cells = workbook.getWorksheets().get(0).getCells();
   
   Iterator en = cells.iterator();
   while (en.hasNext())
   {
       Cell cell = (Cell)en.next();
       System.out.println(cell.getName() + ": " + cell.getValue());
   }

public java.util.Iterator getRowEnumerator()

Gets the rows enumerator.

Returns:

The rows enumerator.

See Also:

RowCollection.iterator()

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.

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.

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:

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.

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.

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.

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

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.

public void addRange(Range rangeObject)

Adds a range object reference to cells

Parameters:

rangeObject - The range object will be contained in the cells

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

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

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

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.

public void clear()

Clears all cell and row objects.

public int importData(ICellsDataTable table, int firstRow, int firstColumn, ImportTableOptions options)
              throws java.lang.Exception

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:

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.

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.

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.

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

public void importObjectArray(java.lang.Object[] objArray, int firstRow, int firstColumn, boolean isVertical)
                      throws java.lang.Exception

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.

public void importArrayList(java.util.ArrayList arrayList, int firstRow, int firstColumn, boolean isVertical)
                    throws java.lang.Exception

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.