com.spire.xls
Class Worksheet

java.lang.Object
  com.spire.xls.core.spreadsheet.XlsObject
      com.spire.xls.core.spreadsheet.XlsWorksheetBase
          com.spire.xls.core.spreadsheet.XlsWorksheet
              com.spire.xls.Worksheet

All Implemented Interfaces:

IWorksheet

public class Worksheet
extends XlsWorksheet

Represents the worksheet.

Method Summary

void	applyStyle(CellStyle style) Apply style to whole sheet.
void	copy(CellRange sourceRange, CellRange destRange) Copys data from a source range to a destination range.
void	copy(CellRange sourceRange, CellRange destRange, boolean copyStyle) Copys data from a source range to a destination range.
void	copy(CellRange sourceRange, CellRange destRange, boolean copyStyle, boolean updateReference, boolean ignoreSize) Copys data from a source range to a destination range.
void	copy(CellRange sourceRange, CellRange destRange, boolean copyStyle, boolean updateReference, boolean ignoreSize, boolean copyShape)
void	copy(CellRange sourceRange, Worksheet worksheet, int destRow, int destColumn) Copy data from source range to destination worksheet.
void	copy(CellRange sourceRange, Worksheet worksheet, int destRow, int destColumn, boolean copyStyle) Copy data from source range to destination worksheet.
void	copy(CellRange sourceRange, Worksheet worksheet, int destRow, int destColumn, boolean copyStyle, boolean updateRerence) Copy data from source range to destination worksheet.
void	copyFrom(Worksheet worksheet) Copy data from specified worksheet.
DataTable	exportDataTable(CellRange range, boolean exportColumnNames) Exports worksheet data into a DataTable.
DataTable	exportDataTable(CellRange range, boolean exportColumnNames, boolean computedFormulaValue) Exports worksheet data into a DataTable.
DataTable	exportDataTable(int firstRow, int firstColumn, int maxRows, int maxColumns, boolean exportColumnNames) Exports worksheet data into a DataTable
CellRange[]	findAll(java.lang.String findValue, java.util.EnumSet<FindType> flags, java.util.EnumSet<ExcelFindOptions> findOptions) Finds the all cells with specified string value.
CellRange[]	findAllBool(boolean boolValue) Finds the cell with the input bool.
CellRange[]	findAllDateTime(java.util.Date dateValue) Finds the cell with the input date time.
CellRange[]	findAllNumber(double doubleValue, boolean formulaValue) Finds the cell with the input number.
CellRange[]	findAllString(java.lang.String stringValue, boolean formula, boolean formulaValue) Finds the cell with the input string.
CellRange	findBool(boolean boolValue) Finds the cell with the input bool.
CellRange	findDateTime(java.util.Date dateValue) Finds the cell with the input date.
CellRange	findString(java.lang.String stringValue, boolean formula, boolean formulaValue) Finds the cell with the input string.
void	freezePanes(int rowIndex, int columnIndex) Freezes panes at the specified cell in the worksheet.
CellRange	getAllocatedRange() Returns a range object that represents the used range on the specified worksheet.
AutoFiltersCollection	getAutoFilters() Returns auto filters collection of worksheet.
Workbook	getBook()
CellRange	getCellRange(int row, int column) Gets cell range.
CellRange	getCellRange(int row, int column, int lastRow, int lastColumn) Gets cell range.
CellRange	getCellRange(java.lang.String name) Gets cell range.
CellRange[]	getCells() Returns all used cells in the worksheet.
WorksheetChartsCollection	getCharts() Returns charts collection.
CellRange[]	getColumns() Rrepresents all used columns on the specified worksheet.
CommentsCollection	getComments() Returns comments collection for this worksheet.
CellStyle	getDefaultColumnStyle(int columnIndex) Returns default column style.
CellStyle	getDefaultRowStyle(int rowIndex) Returns default row style.
HPageBreaksCollection	getHPageBreaks() Returns an HPageBreaks collection that represents the horizontal
HyperLinksCollection	getHyperLinks() Collection of all worksheet's hyperlinks.
CellRange	getIntersectRanges(CellRange range1, CellRange range2) Intersects two ranges.
CellRange[]	getMergedCells() Returns all merged ranges.
PageSetup	getPageSetup() Returns a page setup object that contains all the page setup settings for the specified object.
Workbook	getParentBook()
PicturesCollection	getPictures() Pictures collection.
CellRange	getPrintRange() Print area of worksheet.
CellRange	getRange() Returns a Range object that represents the used range on the specified worksheet.
CellRange[]	getRows() Represents all the rows on the specified worksheet.
VPageBreaksCollection	getVPageBreaks() Returns a VPageBreaks collection that represents the vertical page breaks on the sheet.
CellRange	merge(CellRange range1, CellRange range2) Combines a range of cells into a single cell.
void	move(CellRange sourceRange, CellRange destRange) Move data from source range to destination range.
void	move(CellRange sourceRange, CellRange destRange, boolean updateReference, boolean copyStyle)
void	removeMergedCells(CellRange range) Remove merged cells from specified range.
void	removePicture(int index) Remove picture from this worksheet.
void	removePicture(IPictureShape picture) Remove picture from this worksheet.
void	removePicture(java.lang.String picturename) Remove picture from this worksheet.
void	removeRange(CellRange range) Removes range from list.
void	removeRange(int rowIndex, int columnIndex) Removes range from list.
void	setActiveCell(CellRange range) Sets active cell
void	setDefaultColumnStyle(int columnIndex, CellStyle defaultStyle) Sets default style for column.
void	setDefaultColumnStyle(int firstColumnIndex, int lastColumnIndex, CellStyle defaultStyle) Sets default style for column.
void	setDefaultRowStyle(int rowIndex, CellStyle defaultStyle) Sets default style for row.
void	setDefaultRowStyle(int firstRowIndex, int lastRowIndex, CellStyle defaultStyle) Sets default style for row.

Methods inherited from class com.spire.xls.core.spreadsheet.XlsWorksheet

addAllowEditRange, addAllowEditRange, autoFitColumn, autoFitColumn, autoFitRow, autoFitRow, checkExistence, clear, clearData, columnWidthToPixels, createNamedRanges, deleteColumn, deleteColumn, deleteRange, deleteRow, deleteRow, exportData, exportData, exportData, exportDataTable, get, get, get, getActivePane, getBoolean, getCaculateValue, getCellList, getCellType, getClonedObject, getColumnWidth, getColumnWidthPixels, getConditionalFormats, getDefaultColumnWidth, getDefaultPrintRowHeight, getDefaultRowHeight, getDisplayPageBreaks, getError, getFirstVisibleColumn, getFirstVisibleRow, getFormula, getFormula, getFormulaBoolValue, getFormulaErrorValue, getFormulaNumberValue, getFormulaStringValue, getGridLinesVisible, getHorizontalSplit, getListObjects, getNames, getNumber, getOleObjects, getPivotTables, getProtectContents, getQuotedName, getRowColumnHeadersVisible, getRowHeight, getRowHeightPixels, getSelectionCount, getSparklineGroups, getStandardHeightFlag, getStringValue, getText, getTextObject, getTopLeftCell, getType, getUseRangesCache, getVersion, getVerticalSplit, getViewMode, getZoom, getZoomScaleNormal, getZoomScalePageBreakView, getZoomScalePageLayoutView, groupByColumns, groupByRows, hasArrayFormula, hasArrayFormulaRecord, hasMergedCells, hasOleObjects, hideColumn, hideRow, importDataTable, importDataTable, insertArray, insertArray, insertArray, insertArray, insertArray, insertArray, insertArrayList, insertArrayT, insertColumn, insertColumn, insertColumn, insertDataColumn, insertDataColumns, insertDataTable, insertDataTable, insertDataTable, insertDataTable, insertDataTable, insertDataView, insertDataView, insertDataView, insertDataView, insertRange, insertRow, insertRow, insertRow, isArrayFormula, isColumnVisible, isDisplayZeros, isEmpty, isExternalFormula, isFreezePanes, isRowVisible, isStringsPreserved, isStringsPreserved, moveWorksheet, pixelsToColumnWidth, remove, removeMergedCells, removePanes, replace, replace, replace, replace, replace, replace, replace, replace, saveToEMFImage, saveToFile, saveToFile, saveToHtml, saveToHtml, saveToHtml, saveToImage, saveToImage, saveToPdf, saveToPdfStream, saveToStream, saveToStream, setActiveCell, setActivePane, setBlank, setBoolean, setCaculateValue, setCellValue, setCellValue, setColumnWidth, setColumnWidthInPixels, setColumnWidthInPixels, setDefaultColumnStyle, setDefaultColumnStyle, setDefaultColumnWidth, setDefaultPrintRowHeight, setDefaultRowHeight, setDefaultRowStyle, setDefaultRowStyle, setDisplayPageBreaks, setError, setFirstColumn, setFirstRow, setFirstVisibleColumn, setFirstVisibleRow, setFormula, setFormula, setFormulaBoolValue, setFormulaErrorValue, setFormulaNumberValue, setFormulaStringValue, setGridLinesVisible, setHorizontalSplit, setLastColumn, setLastRow, setNumber, setRowColumnHeadersVisible, setRowHeight, setRowHeightInPixels, setRowHeightPixels, setStandardHeightFlag, setText, setTopLeftCell, setUseRangesCache, setVerticalSplit, setViewMode, setZoom, setZoomScaleNormal, setZoomScalePageBreakView, setZoomScalePageLayoutView, showColumn, showRow, toImage, toSVGStream, ungroupByColumns, ungroupByRows

Methods inherited from class com.spire.xls.core.spreadsheet.XlsWorksheetBase

activate, getArcShapes, getCheckBoxes, getCodeName, getComboBoxes, getDefaultGridlineColor, getFirstColumn, getFirstRow, getGridLineColor, getGroupBoxes, getHeaderFooterShapes, getIndex, getLastColumn, getLastRow, getLeftVisibleColumn, getName, getOvalShapes, getParentWorkbook, getProtectDrawingObjects, getProtection, getProtectScenarios, getPrstGeomShapes, getRadioButtons, getRealIndex, getRectangleShapes, getScrollBarShapes, getShapes, getSheetId, getSpinnerShapes, getTabColor, getTabColorObject, getTabKnownColor, getTextBoxes, getTopVisibleRow, getTypedCheckBoxes, getTypedComboBoxes, getTypedLines, getTypedPictures, getTypedTextBoxes, getUnknownVmlShapes, getVisibility, getVmlShapesCount, getWorkbook, hasPictures, hasVmlShapes, isPasswordProtected, isRightToLeft, isRightToLeft, isSelected, protect, protect, select, selectTab, setChanged, setGridLineColor, setIndex, setLeftVisibleColumn, setName, setRealIndex, setTabColor, setTabKnownColor, setTopVisibleRow, setUnknownVmlShapes, setVisibility, unprotect, unprotect, unselect, unselect

Methods inherited from class com.spire.xls.core.spreadsheet.XlsObject

dispose

Methods inherited from interface com.spire.xls.core.IWorksheet

copyToClipboard, getCodeName, getGridLineColor, getIndex, getLeftVisibleColumn, getTopVisibleRow, protect, saveToImage, saveToImage, saveToImage, saveToStream, setError, setValue, unprotect

Method Detail

getAllocatedRange

public CellRange getAllocatedRange()

Returns a range object that represents the used range on the specified worksheet. Read-only.

Specified by:

getAllocatedRange in interface IWorksheet

Overrides:

getAllocatedRange in class XlsWorksheet

Returns:

Cell range

getCellRange

public CellRange getCellRange(int row,
                              int column,
                              int lastRow,
                              int lastColumn)

Gets cell range.

Parameters:

row -

column -

lastRow -

lastColumn -

Returns:

getCellRange

public CellRange getCellRange(int row,
                              int column)

Gets cell range.

Parameters:

row -

column -

Returns:

getCellRange

public CellRange getCellRange(java.lang.String name)

Gets cell range.

Parameters:

name - Cell name

Returns:

getMergedCells

public CellRange[] getMergedCells()

Returns all merged ranges. Read-only.

Specified by:

getMergedCells in interface IWorksheet

Overrides:

getMergedCells in class XlsWorksheet

Returns:

findAll

public CellRange[] findAll(java.lang.String findValue,
                           java.util.EnumSet<FindType> flags,
                           java.util.EnumSet<ExcelFindOptions> findOptions)

Finds the all cells with specified string value.

Parameters:

findValue - Value to search.

flags - Type of value to search.

findOptions - Way to search.

Returns:

All found cells, or Null if value was not found.

findAllNumber

public CellRange[] findAllNumber(double doubleValue,
                                 boolean formulaValue)

Finds the cell with the input number.

Parameters:

doubleValue - Double value to search for.

formulaValue - Indicates if includes formula value.

Returns:

Found ranges.

findAllString

public CellRange[] findAllString(java.lang.String stringValue,
                                 boolean formula,
                                 boolean formulaValue)

Finds the cell with the input string.

Parameters:

stringValue - String value to search for.

formula - Indicates if includes formula.

formulaValue - Indicates if includes formula value.

Returns:

Found ranges.

findAllDateTime

public CellRange[] findAllDateTime(java.util.Date dateValue)

Finds the cell with the input date time.

Parameters:

dateValue - Date value to search for.

Returns:

Found ranges.

findAllBool

public CellRange[] findAllBool(boolean boolValue)

Finds the cell with the input bool.

Parameters:

boolValue - Bool value to search for.

Returns:

Found ranges.

findBool

public CellRange findBool(boolean boolValue)

Finds the cell with the input bool.

Parameters:

boolValue - Bool value to search for.

Returns:

Found range.

findString

public CellRange findString(java.lang.String stringValue,
                            boolean formula,
                            boolean formulaValue)

Finds the cell with the input string.

Parameters:

stringValue - String value to search for.

formula - Indicates whether includes formula.

formulaValue - Indicates whether includes formula value.

Returns:

findDateTime

public CellRange findDateTime(java.util.Date dateValue)

Finds the cell with the input date.

Parameters:

dateValue - Date value to search for.

Returns:

Found range.

copyFrom

public void copyFrom(Worksheet worksheet)

Copy data from specified worksheet.

Parameters:

worksheet - worksheet object

copy

public void copy(CellRange sourceRange,
                 CellRange destRange)

Copys data from a source range to a destination range.

Parameters:

sourceRange - Source range.

destRange - Destination range.

copy

public void copy(CellRange sourceRange,
                 CellRange destRange,
                 boolean copyStyle)

Copys data from a source range to a destination range.

Parameters:

sourceRange - Source range.

destRange - Destination range.

copyStyle - Indicates whether copys styles.

copy

public void copy(CellRange sourceRange,
                 CellRange destRange,
                 boolean copyStyle,
                 boolean updateReference,
                 boolean ignoreSize)

Copys data from a source range to a destination range.

Parameters:

sourceRange - Source range.

destRange - Destination range

copyStyle - Indicates whether copy styles.

updateReference - Indicates whether update reference ranges.

ignoreSize - Indicates whether check range sizes.

copy

public void copy(CellRange sourceRange,
                 Worksheet worksheet,
                 int destRow,
                 int destColumn)

Copy data from source range to destination worksheet.

Parameters:

sourceRange - Source range.

worksheet - Destination worksheet

destRow - Row index of destination worksheet.

destColumn - Column index of destination worksheet.

copy

public void copy(CellRange sourceRange,
                 Worksheet worksheet,
                 int destRow,
                 int destColumn,
                 boolean copyStyle)

Copy data from source range to destination worksheet.

Parameters:

sourceRange - Source range

worksheet - Destination worksheet.

destRow - Row index of destination worksheet.

destColumn - Column index of destination worksheet.

copyStyle - Indicates whehter copy styles.

copy

public void copy(CellRange sourceRange,
                 Worksheet worksheet,
                 int destRow,
                 int destColumn,
                 boolean copyStyle,
                 boolean updateRerence)

Copy data from source range to destination worksheet.

Parameters:

sourceRange - Source range

worksheet - Destination worksheet.

destRow - Row index of destination worksheet.

destColumn - Column index of destination worksheet.

copyStyle - Indicates whehter copy styles.

updateRerence - Indicates whether update reference range.

copy

public void copy(CellRange sourceRange,
                 CellRange destRange,
                 boolean copyStyle,
                 boolean updateReference,
                 boolean ignoreSize,
                 boolean copyShape)

Parameters:

sourceRange - Source range.

destRange - Destination range

copyStyle - Indicates whether copy styles.

updateReference - Indicates whether update reference ranges.

ignoreSize - Indicates whether check range sizes.

copyShape - Indicates whether copy shape.

move

public void move(CellRange sourceRange,
                 CellRange destRange)

Move data from source range to destination range.

Parameters:

sourceRange - Source range.

destRange - Destination range.

move

public void move(CellRange sourceRange,
                 CellRange destRange,
                 boolean updateReference,
                 boolean copyStyle)

exportDataTable

public DataTable exportDataTable(CellRange range,
                                 boolean exportColumnNames)

Exports worksheet data into a DataTable.

Parameters:

range - Range to export.

exportColumnNames - Indicates if export column name.

Returns:

exported datatable

exportDataTable

public DataTable exportDataTable(CellRange range,
                                 boolean exportColumnNames,
                                 boolean computedFormulaValue)

Exports worksheet data into a DataTable.

Parameters:

range - Range to export.

exportColumnNames - Indicates if export column name.

computedFormulaValue - Indicates wheter compute formula value.

Returns:

exported datatable

exportDataTable

public DataTable exportDataTable(int firstRow,
                                 int firstColumn,
                                 int maxRows,
                                 int maxColumns,
                                 boolean exportColumnNames)

Exports worksheet data into a DataTable

Parameters:

firstRow - Row of first cell.

firstColumn - Column of first cell.

maxRows - Maximun rows to export.

maxColumns - Maximun columns to export.

exportColumnNames - Indicates if export column name.

Returns:

Exported datatable.

getIntersectRanges

public CellRange getIntersectRanges(CellRange range1,
                                    CellRange range2)

Intersects two ranges.

Parameters:

range1 - First range.

range2 - Second range.

Returns:

Intersection of two ranges

merge

public CellRange merge(CellRange range1,
                       CellRange range2)

Combines a range of cells into a single cell.

Parameters:

range1 - First range.

range2 - Second range.

Returns:

Merged ranges

setDefaultColumnStyle

public void setDefaultColumnStyle(int columnIndex,
                                  CellStyle defaultStyle)

Sets default style for column.

Parameters:

columnIndex - Column index.

defaultStyle - Default style.

setDefaultColumnStyle

public void setDefaultColumnStyle(int firstColumnIndex,
                                  int lastColumnIndex,
                                  CellStyle defaultStyle)

Sets default style for column.

Parameters:

firstColumnIndex - First column index.

lastColumnIndex - Last column index.

defaultStyle - Default style.

setDefaultRowStyle

public void setDefaultRowStyle(int rowIndex,
                               CellStyle defaultStyle)

Sets default style for row.

Parameters:

rowIndex - Row index.

defaultStyle - Default style.

setDefaultRowStyle

public void setDefaultRowStyle(int firstRowIndex,
                               int lastRowIndex,
                               CellStyle defaultStyle)

Sets default style for row.

Parameters:

firstRowIndex - First row index.

lastRowIndex - Last row index.

defaultStyle - Default style.

getDefaultColumnStyle

public CellStyle getDefaultColumnStyle(int columnIndex)

Returns default column style.

Specified by:

getDefaultColumnStyle in interface IWorksheet

Overrides:

getDefaultColumnStyle in class XlsWorksheet

Parameters:

columnIndex - Column index.

Returns:

Default column style or null if default style is not exists.

getDefaultRowStyle

public CellStyle getDefaultRowStyle(int rowIndex)

Returns default row style.

Specified by:

getDefaultRowStyle in interface IWorksheet

Overrides:

getDefaultRowStyle in class XlsWorksheet

Parameters:

rowIndex - Row index.

Returns:

removeMergedCells

public void removeMergedCells(CellRange range)

Remove merged cells from specified range.

Parameters:

range - Specified range.

removeRange

public void removeRange(CellRange range)

Removes range from list.

Parameters:

range - Specified range.

removeRange

public void removeRange(int rowIndex,
                        int columnIndex)

Removes range from list.

Parameters:

rowIndex - Row index.

columnIndex - Column index.

removePicture

public void removePicture(int index)

Remove picture from this worksheet.

Parameters:

index - Picture ID

removePicture

public void removePicture(java.lang.String picturename)

Remove picture from this worksheet.

Parameters:

picturename - Picture name

removePicture

public void removePicture(IPictureShape picture)

Remove picture from this worksheet.

Parameters:

picture - A pictureshape

applyStyle

public void applyStyle(CellStyle style)

Apply style to whole sheet.

Overrides:

applyStyle in class XlsWorksheet

Parameters:

style - style to apply

freezePanes

public void freezePanes(int rowIndex,
                        int columnIndex)

Freezes panes at the specified cell in the worksheet.

Parameters:

rowIndex - Row index.

columnIndex - Column index.

setActiveCell

public void setActiveCell(CellRange range)

Sets active cell

Parameters:

range - Cell to activate.

getCells

public CellRange[] getCells()

Returns all used cells in the worksheet. Read-only.

Specified by:

getCells in interface IWorksheet

Overrides:

getCells in class XlsWorksheet

Returns:

getColumns

public CellRange[] getColumns()

Rrepresents all used columns on the specified worksheet. Read-only Range object.

Specified by:

getColumns in interface IWorksheet

Overrides:

getColumns in class XlsWorksheet

Returns:

getPageSetup

public PageSetup getPageSetup()

Returns a page setup object that contains all the page setup settings for the specified object. Read-only.

Specified by:

getPageSetup in interface IWorksheet

Overrides:

getPageSetup in class XlsWorksheet

Returns:

getAutoFilters

public AutoFiltersCollection getAutoFilters()

Returns auto filters collection of worksheet. Read-only.

Specified by:

getAutoFilters in interface IWorksheet

Overrides:

getAutoFilters in class XlsWorksheet

Returns:

getCharts

public WorksheetChartsCollection getCharts()

Returns charts collection. Read-only.

Overrides:

getCharts in class XlsWorksheetBase

Returns:

getComments

public CommentsCollection getComments()

Returns comments collection for this worksheet. Read-only.

Specified by:

getComments in interface IWorksheet

Overrides:

getComments in class XlsWorksheetBase

Returns:

getHPageBreaks

public HPageBreaksCollection getHPageBreaks()

Returns an HPageBreaks collection that represents the horizontal

Specified by:

getHPageBreaks in interface IWorksheet

Overrides:

getHPageBreaks in class XlsWorksheet

Returns:

getHyperLinks

public HyperLinksCollection getHyperLinks()

Collection of all worksheet's hyperlinks.

Specified by:

getHyperLinks in interface IWorksheet

Overrides:

getHyperLinks in class XlsWorksheet

Returns:

getPictures

public PicturesCollection getPictures()

Pictures collection. Read-only.

Overrides:

getPictures in class XlsWorksheetBase

Returns:

getPrintRange

public CellRange getPrintRange()

Print area of worksheet.

Returns:

getVPageBreaks

public VPageBreaksCollection getVPageBreaks()

Returns a VPageBreaks collection that represents the vertical page breaks on the sheet. Read-only.

Specified by:

getVPageBreaks in interface IWorksheet

Overrides:

getVPageBreaks in class XlsWorksheet

Returns:

getRange

public CellRange getRange()

Returns a Range object that represents the used range on the specified worksheet. Read-only.

Specified by:

getRange in interface IWorksheet

Overrides:

getRange in class XlsWorksheet

Returns:

getRows

public CellRange[] getRows()

Represents all the rows on the specified worksheet. Read-only range object.

Specified by:

getRows in interface IWorksheet

Overrides:

getRows in class XlsWorksheet

Returns:

getBook

public Workbook getBook()

getParentBook

public Workbook getParentBook()