asposecells.api

Classes

Constants

Class Worksheet

Encapsulates the object that represents a single worksheet.

Example:

workbook = Workbook()
sheet = workbook.getWorksheets().get(0)
# Freeze panes at "AS40" with 10 rows and 10 columns
sheet.freezePanes("AS40", 10, 10)
# Add a hyperlink in Cell A1
sheet.getHyperlinks().add("A1", 1, 1, "http://www.aspose.com")

Property Getters/Setters Summary
`method`	`getActiveCell()`
`method`	`setActiveCell(value)`
	Gets or sets the active cell in the worksheet.
`method`	`getAllowEditRanges()`
	Gets the allow edit range collection in the worksheet.
`method`	`getAutoFilter()`
	Represents auto filter for the specified worksheet.
`method`	`getBackgroundImage()`
`method`	`setBackgroundImage(value)`
	Gets and sets worksheet background image.
`method`	`getCells()`
	Gets the Cells collection.
`method`	`getCellWatches()`
	Gets collection of cells on this worksheet being watched in the 'watch window'.
`method`	`getCharts()`
	Gets a Chart collection
`method`	`getCheckBoxes()`
	Gets a CheckBox collection.
`method`	`getCodeName()`
`method`	`setCodeName(value)`
	Gets worksheet code name.
`method`	`getComments()`
	Gets the Comment collection.
`method`	`getConditionalFormattings()`
	Gets the ConditionalFormattings in the worksheet.
`method`	`getCustomProperties()`
	Gets an object representing the identifier information associated with a worksheet.
`method`	`getDisplayRightToLeft()`
`method`	`setDisplayRightToLeft(value)`
	Indicates if the specified worksheet is displayed from right to left instead of from left to right. Default is false.
`method`	`getDisplayZeros()`
`method`	`setDisplayZeros(value)`
	True if zero values are displayed.
`method`	`getErrorCheckOptions()`
	Gets error check setting applied on certain ranges.
`method`	`getFirstVisibleColumn()`
`method`	`setFirstVisibleColumn(value)`
	Represents first visible column index.
`method`	`getFirstVisibleRow()`
`method`	`setFirstVisibleRow(value)`
	Represents first visible row index.
`method`	`hasAutofilter()`
	Indicates whether this worksheet has auto filter.
`method`	`getHorizontalPageBreaks()`
	Gets the HorizontalPageBreakCollection collection.
`method`	`getHyperlinks()`
	Gets the HyperlinkCollection collection.
`method`	`getIndex()`
	Gets the index of sheet in the worksheet collection.
`method`	`isGridlinesVisible()`
`method`	`setGridlinesVisible(value)`
	Gets or sets a value indicating whether the gridlines are visible.Default is true.
`method`	`isOutlineShown()`
`method`	`setOutlineShown(value)`
	Indicates whether to show outline.
`method`	`isPageBreakPreview()`
`method`	`setPageBreakPreview(value)`
	Indicates whether the specified worksheet is shown in normal view or page break preview.
`method`	`isProtected()`
	Indicates if the worksheet is protected.
`method`	`isRowColumnHeadersVisible()`
`method`	`setRowColumnHeadersVisible(value)`
	Gets or sets a value indicating whether the worksheet will display row and column headers. Default is true.
`method`	`isRulerVisible()`
`method`	`setRulerVisible(value)`
	Indicates whether the ruler is visible. This property is only applied for page break preview.
`method`	`isSelected()`
`method`	`setSelected(value)`
	Indicates whether this worksheet is selected when the workbook is opened.
`method`	`isVisible()`
`method`	`setVisible(value)`
	Represents if the worksheet is visible.
`method`	`getListObjects()`
	Gets all ListObjects in this worksheet.
`method`	`getName()`
`method`	`setName(value)`
	Gets or sets the name of the worksheet.
`method`	`getOleObjects()`
	Represents a collection of OleObject in a worksheet.
`method`	`getOutline()`
	Gets the outline on this worksheet.
`method`	`getPageSetup()`
	Represents the page setup description in this sheet.
`method`	`getPaneState()`
	Indicates whether the pane has horizontal or vertical splits, and whether those splits are frozen. The value of the property is PaneStateType integer constant.
`method`	`getPictures()`
	Gets a Picture collection.
`method`	`getPivotTables()`
	Gets all pivot tables in this worksheet.
`method`	`getProtection()`
	Represents the various types of protection options available for a worksheet. Supports advanced protection options in ExcelXP and above version.
`method`	`getQueryTables()`
	Gets QueryTableCollection in the worksheet.
`method`	`getScenarios()`
	Gets the collection of Scenario.
`method`	`getShapes()`
	Returns all drawing shapes in this worksheet.
`method`	`getShowFormulas()`
`method`	`setShowFormulas(value)`
	Indicates whether to show formulas or their results.
`method`	`getSlicers()`
	Get the Slicer collection in the worksheet
`method`	`getSmartTagSetting()`
	Gets all SmartTagCollection objects of the worksheet.
`method`	`getSparklineGroups()`
	Gets the sparkline groups in the worksheet.
`method`	`getTabColor()`
`method`	`setTabColor(value)`
	Represents worksheet tab color.
`method`	`getTabId()`
`method`	`setTabId(value)`
	Specifies the internal identifier for the sheet.
`method`	`getTextBoxes()`
	Gets a TextBox collection.
`method`	`getTimelines()`
	Get the Timeline collection in the worksheet
`method`	`getTransitionEntry()`
`method`	`setTransitionEntry(value)`
	Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.
`method`	`getTransitionEvaluation()`
`method`	`setTransitionEvaluation(value)`
	Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.
`method`	`getType()`
`method`	`setType(value)`
	Represents worksheet type. The value of the property is SheetType integer constant.
`method`	`getUniqueId()`
`method`	`setUniqueId(value)`
	Gets and sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}.
`method`	`getValidations()`
	Gets the data validation setting collection in the worksheet.
`method`	`getVerticalPageBreaks()`
	Gets the VerticalPageBreakCollection collection.
`method`	`getViewType()`
`method`	`setViewType(value)`
	Gets and sets the view type. The value of the property is ViewType integer constant.
`method`	`getVisibilityType()`
`method`	`setVisibilityType(value)`
	Indicates the visible state for this sheet. The value of the property is VisibilityType integer constant.
`method`	`getWorkbook()`
	Gets the workbook object which contains this sheet.
`method`	`getZoom()`
`method`	`setZoom(value)`
	Represents the scaling factor in percentage. It should be between 10 and 400.

Method Summary
`method`	`addPageBreaks(cellName)`
`method`	Adds page break.
`method`	`advancedFilter(isFilter, listRange, criteriaRange, copyTo, uniqueRecordOnly)`
`method`	Filters data using complex criteria.
`method`	`autoFitColumn(columnIndex)`
`method`	Autofits the column width.
`method`	`autoFitColumn(columnIndex, firstRow, lastRow)`
`method`	Autofits the column width.
`method`	`autoFitColumns()`
`method`	Autofits all columns in this worksheet.
`method`	`autoFitColumns(options)`
`method`	Autofits all columns in this worksheet.
`method`	`autoFitColumns(firstColumn, lastColumn)`
`method`	Autofits the columns width.
`method`	`autoFitColumns(firstColumn, lastColumn, options)`
`method`	Autofits the columns width.
`method`	`autoFitColumns(firstRow, firstColumn, lastRow, lastColumn)`
`method`	Autofits the columns width.
`method`	`autoFitColumns(firstRow, firstColumn, lastRow, lastColumn, options)`
`method`	Autofits the columns width.
`method`	`autoFitRow(rowIndex)`
`method`	Autofits the row height.
`method`	`autoFitRow(rowIndex, firstColumn, lastColumn)`
`method`	Autofits the row height.
`method`	`autoFitRow(rowIndex, firstColumn, lastColumn, options)`
`method`	Autofits the row height.
`method`	`autoFitRow(startRow, endRow, startColumn, endColumn)`
`method`	Autofits row height in a rectangle range.
`method`	`autoFitRows()`
`method`	Autofits all rows in this worksheet.
`method`	`autoFitRows(onlyAuto)`
`method`	Autofits all rows in this worksheet.
`method`	`autoFitRows(options)`
`method`	Autofits all rows in this worksheet.
`method`	`autoFitRows(startRow, endRow)`
`method`	Autofits row height in a range.
`method`	`autoFitRows(startRow, endRow, options)`
`method`	Autofits row height in a range.
`method`	`calculateArrayFormula(formula, opts)`
`method`	Calculates a formula as array formula.
`method`	`calculateArrayFormula(formula, opts, maxRowCount, maxColumnCount)`
`method`	Calculates a formula as array formula.
`method`	`calculateArrayFormula(formula, pOpts, cOpts, baseCellRow, baseCellColumn, maxRowCount, maxColumnCount, calculationData)`
`method`	Calculates a formula as array formula.
`method`	`calculateFormula(options, recursive)`
`method`	Calculates all formulas in this worksheet.
`method`	`calculateFormula(formula)`
`method`	Calculates a formula.
`method`	`calculateFormula(formula, opts)`
`method`	Calculates a formula expression directly.
`method`	`calculateFormula(formula, pOpts, cOpts, baseCellRow, baseCellColumn, calculationData)`
`method`	Calculates a formula expression directly.
`method`	`clearComments()`
`method`	Clears all comments in designer spreadsheet.
`method`	`closeAccessCache(opts)`
`method`	Closes the session that uses caches to access the data in this worksheet.
`method`	`convertFormulaReferenceStyle(formula, toR1C1, baseCellRow, baseCellColumn)`
`method`	Converts the formula reference style.
`method`	`copy(sourceSheet)`
`method`	Copies contents and formats from another worksheet.
`method`	`copy(sourceSheet, copyOptions)`
`method`	Copies contents and formats from another worksheet.
`method`	`dispose()`
`method`	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
`method`	`freezePanes(row, column, freezedRows, freezedColumns)`
`method`	Freezes panes at the specified cell in the worksheet.
`method`	`freezePanes(cellName, freezedRows, freezedColumns)`
`method`	Freezes panes at the specified cell in the worksheet.
`method`	`getAdvancedFilter()`
`method`	Gets the settings of advanced filter.
`method`	`getFreezedPanes()`
`method`	Gets the freeze panes.
`method`	`getPanes()`
`method`	Gets the window panes.
`method`	`getPrintingPageBreaks(options)`
`method`	Gets automatic page breaks.
`method`	`getSelectedRanges()`
`method`	Gets selected ranges of cells in the designer spreadsheet.
`method`	`moveTo(index)`
`method`	Moves the sheet to another location in the spreadsheet.
`method`	`protect(type)`
`method`	Protects worksheet.
`method`	`protect(type, password, oldPassword)`
`method`	Protects worksheet.
`method`	`refreshPivotTables()`
`method`	Refreshes all the PivotTables in this Worksheet.
`method`	`refreshPivotTables(option)`
`method`	Refreshes all the PivotTables in this Worksheet.
`method`	`removeAllDrawingObjects()`
`method`	Removes all drawing objects in this worksheet.
`method`	`removeAutoFilter()`
`method`	Removes the auto filter of the worksheet.
`method`	`removeSplit()`
`method`	Removes split window.
`method`	`replace(oldString, newString)`
`method`	Replaces all cells' text with a new string.
`method`	`selectRange(startRow, startColumn, totalRows, totalColumns, removeOthers)`
`method`	Selects a range.
`method`	`setVisible(isVisible, ignoreError)`
`method`	Sets the visible options.
`method`	`split()`
`method`	Splits window.
`method`	`startAccessCache(opts)`
`method`	Starts the session that uses caches to access the data in this worksheet.
`method`	`toString()`
`method`	Returns a string represents the current Worksheet object.
`method`	`unFreezePanes()`
`method`	Unfreezes panes in the worksheet.
`method`	`unprotect()`
`method`	Unprotects worksheet.
`method`	`unprotect(password)`
`method`	Unprotects worksheet.
`method`	`xmlMapQuery(path, xmlMap)`
`method`	Query cell areas that mapped/linked to the specific path of xml map.

- Property Getters/Setters Detail
  - getProtection : Protection
```
Protection getProtection()
```
    Represents the various types of protection options available for a worksheet. Supports advanced protection options in ExcelXP and above version.
    This property can protect worksheet in all versions of Excel file and support advanced protection options in ExcelXP and above version.
  - getUniqueId/setUniqueId : String
```
String getUniqueId() / setUniqueId(value)
```
    Gets and sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}.
  - getWorkbook : Workbook
```
Workbook getWorkbook()
```
    Gets the workbook object which contains this sheet.
  - getCells : Cells
```
Cells getCells()
```
    Gets the Cells collection.
  - getQueryTables : QueryTableCollection
```
QueryTableCollection getQueryTables()
```
    Gets QueryTableCollection in the worksheet.
  - getPivotTables : PivotTableCollection
```
PivotTableCollection getPivotTables()
```
    Gets all pivot tables in this worksheet.
  - getType/setType : int
```
int getType() / setType(value)
```
    Represents worksheet type. The value of the property is SheetType integer constant.
  - getName/setName : String
```
String getName() / setName(value)
```
    Gets or sets the name of the worksheet.
    The max length of sheet name is 31. And you cannot assign same name(case insensitive) to two worksheets. For example, you cannot set "SheetName1" to the first worksheet and set "SHEETNAME1" to the second worksheet.
  - getShowFormulas/setShowFormulas : boolean
```
boolean getShowFormulas() / setShowFormulas(value)
```
    Indicates whether to show formulas or their results.
  - isGridlinesVisible/setGridlinesVisible : boolean
```
boolean isGridlinesVisible() / setGridlinesVisible(value)
```
    Gets or sets a value indicating whether the gridlines are visible.Default is true.
  - isRowColumnHeadersVisible/setRowColumnHeadersVisible : boolean
```
boolean isRowColumnHeadersVisible() / setRowColumnHeadersVisible(value)
```
    Gets or sets a value indicating whether the worksheet will display row and column headers. Default is true.
  - getPaneState : int
```
int getPaneState()
```
    Indicates whether the pane has horizontal or vertical splits, and whether those splits are frozen. The value of the property is PaneStateType integer constant.
  - getDisplayZeros/setDisplayZeros : boolean
```
boolean getDisplayZeros() / setDisplayZeros(value)
```
    True if zero values are displayed.
  - getDisplayRightToLeft/setDisplayRightToLeft : boolean
```
boolean getDisplayRightToLeft() / setDisplayRightToLeft(value)
```
    Indicates if the specified worksheet is displayed from right to left instead of from left to right. Default is false.
  - isOutlineShown/setOutlineShown : boolean
```
boolean isOutlineShown() / setOutlineShown(value)
```
    Indicates whether to show outline.
  - isSelected/setSelected : boolean
```
boolean isSelected() / setSelected(value)
```
    Indicates whether this worksheet is selected when the workbook is opened.
  - getListObjects : ListObjectCollection
```
ListObjectCollection getListObjects()
```
    Gets all ListObjects in this worksheet.
  - getTabId/setTabId : int
```
int getTabId() / setTabId(value)
```
    Specifies the internal identifier for the sheet.
  - getHorizontalPageBreaks : HorizontalPageBreakCollection
```
HorizontalPageBreakCollection getHorizontalPageBreaks()
```
    Gets the HorizontalPageBreakCollection collection.
  - getVerticalPageBreaks : VerticalPageBreakCollection
```
VerticalPageBreakCollection getVerticalPageBreaks()
```
    Gets the VerticalPageBreakCollection collection.
  - getHyperlinks : HyperlinkCollection
```
HyperlinkCollection getHyperlinks()
```
    Gets the HyperlinkCollection collection.
  - getPageSetup : PageSetup
```
PageSetup getPageSetup()
```
    Represents the page setup description in this sheet.
  - getAutoFilter : AutoFilter
```
AutoFilter getAutoFilter()
```
    Represents auto filter for the specified worksheet.
  - hasAutofilter : boolean
```
boolean hasAutofilter()
```
    Indicates whether this worksheet has auto filter.
  - getTransitionEvaluation/setTransitionEvaluation : boolean
```
boolean getTransitionEvaluation() / setTransitionEvaluation(value)
```
    Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.
  - getTransitionEntry/setTransitionEntry : boolean
```
boolean getTransitionEntry() / setTransitionEntry(value)
```
    Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.
  - getVisibilityType/setVisibilityType : int
```
int getVisibilityType() / setVisibilityType(value)
```
    Indicates the visible state for this sheet. The value of the property is VisibilityType integer constant.
  - isVisible/setVisible : boolean
```
boolean isVisible() / setVisible(value)
```
    Represents if the worksheet is visible.
  - getSparklineGroups : SparklineGroupCollection
```
SparklineGroupCollection getSparklineGroups()
```
    Gets the sparkline groups in the worksheet.
  - getCharts : ChartCollection
```
ChartCollection getCharts()
```
    Gets a Chart collection
  - getComments : CommentCollection
```
CommentCollection getComments()
```
    Gets the Comment collection.
  - getPictures : PictureCollection
```
PictureCollection getPictures()
```
    Gets a Picture collection.
  - getTextBoxes : TextBoxCollection
```
TextBoxCollection getTextBoxes()
```
    Gets a TextBox collection.
  - getCheckBoxes : CheckBoxCollection
```
CheckBoxCollection getCheckBoxes()
```
    Gets a CheckBox collection.
  - getOleObjects : OleObjectCollection
```
OleObjectCollection getOleObjects()
```
    Represents a collection of OleObject in a worksheet.
  - getShapes : ShapeCollection
```
ShapeCollection getShapes()
```
    Returns all drawing shapes in this worksheet.
  - getSlicers : SlicerCollection
```
SlicerCollection getSlicers()
```
    Get the Slicer collection in the worksheet
  - getTimelines : TimelineCollection
```
TimelineCollection getTimelines()
```
    Get the Timeline collection in the worksheet
  - getIndex : int
```
int getIndex()
```
    Gets the index of sheet in the worksheet collection.
  - isProtected : boolean
```
boolean isProtected()
```
    Indicates if the worksheet is protected.
  - getValidations : ValidationCollection
```
ValidationCollection getValidations()
```
    Gets the data validation setting collection in the worksheet.
  - getAllowEditRanges : ProtectedRangeCollection
```
ProtectedRangeCollection getAllowEditRanges()
```
    Gets the allow edit range collection in the worksheet.
  - getErrorCheckOptions : ErrorCheckOptionCollection
```
ErrorCheckOptionCollection getErrorCheckOptions()
```
    Gets error check setting applied on certain ranges.
  - getOutline : Outline
```
Outline getOutline()
```
    Gets the outline on this worksheet.
  - getFirstVisibleRow/setFirstVisibleRow : int
```
int getFirstVisibleRow() / setFirstVisibleRow(value)
```
    Represents first visible row index.
  - getFirstVisibleColumn/setFirstVisibleColumn : int
```
int getFirstVisibleColumn() / setFirstVisibleColumn(value)
```
    Represents first visible column index.
  - getZoom/setZoom : int
```
int getZoom() / setZoom(value)
```
    Represents the scaling factor in percentage. It should be between 10 and 400.
    Please set the view type first.
  - getViewType/setViewType : int
```
int getViewType() / setViewType(value)
```
    Gets and sets the view type. The value of the property is ViewType integer constant.
  - isPageBreakPreview/setPageBreakPreview : boolean
```
boolean isPageBreakPreview() / setPageBreakPreview(value)
```
    Indicates whether the specified worksheet is shown in normal view or page break preview.
  - isRulerVisible/setRulerVisible : boolean
```
boolean isRulerVisible() / setRulerVisible(value)
```
    Indicates whether the ruler is visible. This property is only applied for page break preview.
  - getTabColor/setTabColor : Color
```
Color getTabColor() / setTabColor(value)
```
    Represents worksheet tab color.
    This feature is only supported in ExcelXP(Excel2002) and later versions. If you save file as Excel97 or Excel2000 format, it will be omitted.
  - getCodeName/setCodeName : String
```
String getCodeName() / setCodeName(value)
```
    Gets worksheet code name.
  - getBackgroundImage/setBackgroundImage : byte[]
```
byte[] getBackgroundImage() / setBackgroundImage(value)
```
    Gets and sets worksheet background image.
  - getConditionalFormattings : ConditionalFormattingCollection
```
ConditionalFormattingCollection getConditionalFormattings()
```
    Gets the ConditionalFormattings in the worksheet.
  - getActiveCell/setActiveCell : String
```
String getActiveCell() / setActiveCell(value)
```
    Gets or sets the active cell in the worksheet.
  - getCustomProperties : CustomPropertyCollection
```
CustomPropertyCollection getCustomProperties()
```
    Gets an object representing the identifier information associated with a worksheet.
    Worksheet.CustomProperties provide a preferred mechanism for storing arbitrary data. It supports legacy third-party document components, as well as those situations that have a stringent need for binary parts.
  - getSmartTagSetting : SmartTagSetting
```
SmartTagSetting getSmartTagSetting()
```
    Gets all SmartTagCollection objects of the worksheet.
  - getScenarios : ScenarioCollection
```
ScenarioCollection getScenarios()
```
    Gets the collection of Scenario.
  - getCellWatches : CellWatchCollection
```
CellWatchCollection getCellWatches()
```
    Gets collection of cells on this worksheet being watched in the 'watch window'.
- Method Detail
  - replace
```
int replace(oldString, newString)
```
    Replaces all cells' text with a new string.
    Parameters:
    oldString: String - Old string value.
    newString: String - New string value.
  - getSelectedRanges
```
ArrayList getSelectedRanges()
```
    Gets selected ranges of cells in the designer spreadsheet.
    Returns:
    An java.util.ArrayList which contains selected ranges.
  - getPrintingPageBreaks
```
CellArea[] getPrintingPageBreaks(options)
```
    Gets automatic page breaks.
    Each cell area represents a paper.
    Parameters:
    options: ImageOrPrintOptions - The print options
    Returns:
    The automatic page breaks areas.
  - toString
```
String toString()
```
    Returns a string represents the current Worksheet object.
    Returns:
  - startAccessCache
```
 startAccessCache(opts)
```
    Starts the session that uses caches to access the data in this worksheet.
    After finishing the access to the data, closeAccessCache(int) should be invoked with same options to clear all caches and recover normal access mode.
    Parameters:
    opts: int - A AccessCacheOptions value. options of data access
  - closeAccessCache
```
 closeAccessCache(opts)
```
    Closes the session that uses caches to access the data in this worksheet.
    Parameters:
    opts: int - A AccessCacheOptions value. options of data access
  - convertFormulaReferenceStyle
```
String convertFormulaReferenceStyle(formula, toR1C1, baseCellRow, baseCellColumn)
```
    Converts the formula reference style.
    Parameters:
    formula: String - The formula to be converted.
    toR1C1: boolean - Which reference style to convert the formula to. If the original formula is of A1 reference style, then this value should be true so the formula will be converted from A1 to R1C1 reference style; If the original formula is of R1C1 reference style, then this value should be false so the formula will be converted from R1C1 to A1 reference style;
    baseCellRow: int - The row index of the base cell.
    baseCellColumn: int - The column index of the base cell.
    Returns:
    The converted formula.
  - calculateFormula
```
Object calculateFormula(formula)
```
    Calculates a formula.
    Parameters:
    formula: String - Formula to be calculated.
    Returns:
    Calculated formula result.
  - calculateFormula
```
Object calculateFormula(formula, opts)
```
    Calculates a formula expression directly.
    The formula will be calculated just like it has been set to cell A1. And the formula will be taken as normal formula. If you need the formula be calculated as an array formula and to get an array for the calculated result, please use calculateArrayFormula(java.lang.String, com.aspose.cells.CalculationOptions) instead.
    Parameters:
    formula: String - Formula to be calculated.
    opts: CalculationOptions - Options for calculating formula
    Returns:
    Calculated result of given formula. The returned object may be of possible types of Cell.Value, or ReferredArea.
  - calculateFormula
```
Object calculateFormula(formula, pOpts, cOpts, baseCellRow, baseCellColumn, calculationData)
```
    Calculates a formula expression directly.
    The formula will be calculated just like it has been set to the specified base cell. And the formula will be taken as normal formula. If you need the formula be calculated as an array formula and to get an array for the calculated result, please use calculateArrayFormula(java.lang.String, com.aspose.cells.FormulaParseOptions, com.aspose.cells.CalculationOptions, int, int, int, int, com.aspose.cells.CalculationData) instead.
    Parameters:
    formula: String - Formula to be calculated.
    pOpts: FormulaParseOptions - Options for parsing formula.
    cOpts: CalculationOptions - Options for calculating formula.
    baseCellRow: int - The row index of the base cell.
    baseCellColumn: int - The column index of the base cell.
    calculationData: CalculationData - The calculation data. It is used for the situation that user needs to calculate some static formulas when implementing custom calculation engine. For such kind of situation, user needs to specify it with the calculation data provided for #Error Cref: M:Aspose.Cells.AbstractCalculationEngine.Calculate(Aspose.Cells.CalculationData).
    Returns:
    Calculated result of given formula. The returned object may be of possible types of Cell.Value, or ReferredArea.
  - calculateArrayFormula
```
Object[][] calculateArrayFormula(formula, opts)
```
    Calculates a formula as array formula.
    Parameters:
    formula: String - Formula to be calculated.
    opts: CalculationOptions - Options for calculating formula
  - calculateArrayFormula
```
Object[][] calculateArrayFormula(formula, opts, maxRowCount, maxColumnCount)
```
    Calculates a formula as array formula.
    The formula will be taken as dynamic array formula to calculate the dimension and result. User specified maximum dimension is used for cases that the calculated result is large data set (for example, the calculated result may correspond to a whole row or column data) but user does not need so large an array according to business requirement or for performance consideration.
    Parameters:
    formula: String - Formula to be calculated.
    opts: CalculationOptions - Options for calculating formula
    maxRowCount: int - the maximum row count of resultant data. If it is non-positive or greater than the actual row count, then actual row count will be used.
    maxColumnCount: int - the maximum column count of resultant data. If it is non-positive or greater than the actual row count, then actual column count will be used.
    Returns:
    Calculated formula result.
  - calculateArrayFormula
```
Object[][] calculateArrayFormula(formula, pOpts, cOpts, baseCellRow, baseCellColumn, maxRowCount, maxColumnCount, calculationData)
```
    Calculates a formula as array formula.
    The formula will be taken as dynamic array formula to calculate the dimension and result. User specified maximum dimension is used for cases that the calculated result is large data set (for example, the calculated result may correspond to a whole row or column data) but user does not need so large an array according to business requirement or for performance consideration.
    Parameters:
    formula: String - Formula to be calculated.
    pOpts: FormulaParseOptions - Options for parsing formula
    cOpts: CalculationOptions - Options for calculating formula
    baseCellRow: int - The row index of the base cell.
    baseCellColumn: int - The column index of the base cell.
    maxRowCount: int - The maximum row count of resultant data. If it is non-positive or greater than the actual row count, then actual row count will be used.
    maxColumnCount: int - The maximum column count of resultant data. If it is non-positive or greater than the actual row count, then actual column count will be used.
    calculationData: CalculationData - The calculation data. It is used for the situation that user needs to calculate some static formulas when implementing custom calculation engine. For such kind of situation, user needs to specify it with the calculation data provided for #Error Cref: M:Aspose.Cells.AbstractCalculationEngine.Calculate(Aspose.Cells.CalculationData).
    Returns:
    Calculated formula result.
  - calculateFormula
```
 calculateFormula(options, recursive)
```
    Calculates all formulas in this worksheet.
    Parameters:
    options: CalculationOptions - Options for calculation
    recursive: boolean - True means if the worksheet' cells depend on the cells of other worksheets, the dependent cells in other worksheets will be calculated too. False means all the formulas in the worksheet have been calculated and the values are right.
  - xmlMapQuery
```
ArrayList xmlMapQuery(path, xmlMap)
```
    Query cell areas that mapped/linked to the specific path of xml map.
    e.g. A xml map element structure: -RootElement |-Attribute1 |-SubElement |-Attribute2 |-Attribute3 To query "Attribute1", path is "/RootElement/@Attribute1" To query "Attribute2", path is "/RootElement/SubElement/@Attribute2" To query whole "SubElement", path is "/RootElement/SubElement"
    Parameters:
    path: String - xml element path
    xmlMap: XmlMap - Specify an xml map if you want to query for the specific path within a specific map
    Returns:
    CellArea list that mapped/linked to the specific path of xml map, an empty list is returned if nothing is mapped/linked.
  - refreshPivotTables
```
 refreshPivotTables()
```
    Refreshes all the PivotTables in this Worksheet.
  - refreshPivotTables
```
 refreshPivotTables(option)
```
    Refreshes all the PivotTables in this Worksheet.
    Parameters:
    option: PivotTableRefreshOption - The option for refreshing data source of pivot table.
  - dispose
```
 dispose()
```
    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  - getPanes
```
PaneCollection getPanes()
```
    Gets the window panes.
    If the window is not split or frozen.
  - freezePanes
```
 freezePanes(row, column, freezedRows, freezedColumns)
```
    Freezes panes at the specified cell in the worksheet.
    Row index and column index cannot all be zero. Number of rows and number of columns also cannot all be zero.
    The first two parameters specify the froze position and the last two parameters specify the area frozen on the left top pane.
    Parameters:
    row: int - Row index.
    column: int - Column index.
    freezedRows: int - Number of visible rows in top pane, no more than row index.
    freezedColumns: int - Number of visible columns in left pane, no more than column index.
  - getFreezedPanes
```
int[] getFreezedPanes()
```
    Gets the freeze panes.
    Returns:
    Return null means the worksheet is not frozen 0:Row index;1:column;2:freezedRows;3:freezedRows
  - split
```
 split()
```
    Splits window.
  - freezePanes
```
 freezePanes(cellName, freezedRows, freezedColumns)
```
    Freezes panes at the specified cell in the worksheet.
    Row index and column index cannot all be zero. Number of rows and number of columns also cannot all be zero.
    Parameters:
    cellName: String - Cell name.
    freezedRows: int - Number of visible rows in top pane, no more than row index.
    freezedColumns: int - Number of visible columns in left pane, no more than column index.
  - unFreezePanes
```
 unFreezePanes()
```
    Unfreezes panes in the worksheet.
  - removeSplit
```
 removeSplit()
```
    Removes split window.
  - addPageBreaks
```
 addPageBreaks(cellName)
```
    Adds page break.
    Parameters:
    cellName: String -
  - copy
```
 copy(sourceSheet)
```
    Copies contents and formats from another worksheet.
    Parameters:
    sourceSheet: Worksheet - Source worksheet.
  - copy
```
 copy(sourceSheet, copyOptions)
```
    Copies contents and formats from another worksheet.
    You can copy data from another worksheet in the same file or another file. However, this method does not support to copy drawing objects, such as comments, images and charts.
    Parameters:
    sourceSheet: Worksheet - Source worksheet.
    copyOptions: CopyOptions -
  - autoFitColumn
```
 autoFitColumn(columnIndex, firstRow, lastRow)
```
    Autofits the column width.
    This method autofits a row based on content in a range of cells within the row.
    Parameters:
    columnIndex: int - Column index.
    firstRow: int - First row index.
    lastRow: int - Last row index.
  - autoFitColumns
```
 autoFitColumns()
```
    Autofits all columns in this worksheet.
  - autoFitColumns
```
 autoFitColumns(options)
```
    Autofits all columns in this worksheet.
    Parameters:
    options: AutoFitterOptions - The auto fitting options
  - autoFitColumn
```
 autoFitColumn(columnIndex)
```
    Autofits the column width.
    AutoFitColumn is an imprecise function.
    Parameters:
    columnIndex: int - Column index.
  - autoFitColumns
```
 autoFitColumns(firstColumn, lastColumn)
```
    Autofits the columns width.
    AutoFitColumn is an imprecise function.
    Parameters:
    firstColumn: int - First column index.
    lastColumn: int - Last column index.
  - autoFitColumns
```
 autoFitColumns(firstColumn, lastColumn, options)
```
    Autofits the columns width.
    AutoFitColumn is an imprecise function.
    Parameters:
    firstColumn: int - First column index.
    lastColumn: int - Last column index.
    options: AutoFitterOptions - The auto fitting options
  - autoFitColumns
```
 autoFitColumns(firstRow, firstColumn, lastRow, lastColumn)
```
    Autofits the columns width.
    AutoFitColumn is an imprecise function.
    Parameters:
    firstRow: int - First row index.
    firstColumn: int - First column index.
    lastRow: int - Last row index.
    lastColumn: int - Last column index.
  - autoFitColumns
```
 autoFitColumns(firstRow, firstColumn, lastRow, lastColumn, options)
```
    Autofits the columns width.
    AutoFitColumn is an imprecise function.
    Parameters:
    firstRow: int - First row index.
    firstColumn: int - First column index.
    lastRow: int - Last row index.
    lastColumn: int - Last column index.
    options: AutoFitterOptions - The auto fitting options
  - autoFitRow
```
 autoFitRow(rowIndex, firstColumn, lastColumn)
```
    Autofits the row height.
    This method autofits a row based on content in a range of cells within the row.
    Parameters:
    rowIndex: int - Row index.
    firstColumn: int - First column index.
    lastColumn: int - Last column index.
  - autoFitRow
```
 autoFitRow(rowIndex, firstColumn, lastColumn, options)
```
    Autofits the row height.
    This method autofits a row based on content in a range of cells within the row.
    Parameters:
    rowIndex: int - Row index.
    firstColumn: int - First column index.
    lastColumn: int - Last column index.
    options: AutoFitterOptions - The auto fitter options
  - autoFitRows
```
 autoFitRows()
```
    Autofits all rows in this worksheet.
  - autoFitRows
```
 autoFitRows(onlyAuto)
```
    Autofits all rows in this worksheet.
    Parameters:
    onlyAuto: boolean - True,only autofits the row height when row height is not customed.
  - autoFitRows
```
 autoFitRows(options)
```
    Autofits all rows in this worksheet.
    Parameters:
    options: AutoFitterOptions - The auto fitter options
  - autoFitRows
```
 autoFitRows(startRow, endRow)
```
    Autofits row height in a range.
    Parameters:
    startRow: int - Start row index.
    endRow: int - End row index.
  - autoFitRows
```
 autoFitRows(startRow, endRow, options)
```
    Autofits row height in a range.
    Parameters:
    startRow: int - Start row index.
    endRow: int - End row index.
    options: AutoFitterOptions - The options of auto fitter.
  - autoFitRow
```
 autoFitRow(startRow, endRow, startColumn, endColumn)
```
    Autofits row height in a rectangle range.
    Parameters:
    startRow: int - Start row index.
    endRow: int - End row index.
    startColumn: int - Start column index.
    endColumn: int - End column index.
  - autoFitRow
```
 autoFitRow(rowIndex)
```
    Autofits the row height.
    AutoFitRow is an imprecise function.
    Parameters:
    rowIndex: int - Row index.
  - getAdvancedFilter
```
AdvancedFilter getAdvancedFilter()
```
    Gets the settings of advanced filter.
    Returns:
  - advancedFilter
```
 advancedFilter(isFilter, listRange, criteriaRange, copyTo, uniqueRecordOnly)
```
    Filters data using complex criteria.
    Parameters:
    isFilter: boolean - Indicates whether filtering the list in place.
    listRange: String - The list range.
    criteriaRange: String - The criteria range.
    copyTo: String - The range where copying data to.
    uniqueRecordOnly: boolean - Only displaying or copying unique rows.
  - removeAutoFilter
```
 removeAutoFilter()
```
    Removes the auto filter of the worksheet.
  - setVisible
```
 setVisible(isVisible, ignoreError)
```
    Sets the visible options.
    Parameters:
    isVisible: boolean - Whether the worksheet is visible
    ignoreError: boolean - Whether to ignore error if this option is not valid.
  - selectRange
```
 selectRange(startRow, startColumn, totalRows, totalColumns, removeOthers)
```
    Selects a range.
    Parameters:
    startRow: int - The start row.
    startColumn: int - The start column
    totalRows: int - The number of rows.
    totalColumns: int - The number of columns
    removeOthers: boolean - True means removing other selected range and only select this range.
  - removeAllDrawingObjects
```
 removeAllDrawingObjects()
```
    Removes all drawing objects in this worksheet.
  - clearComments
```
 clearComments()
```
    Clears all comments in designer spreadsheet.
  - protect
```
 protect(type)
```
    Protects worksheet.
    This method protects worksheet without password. It can protect worksheet in all versions of Excel file.
    Parameters:
    type: int - A ProtectionType value. Protection type.
  - protect
```
 protect(type, password, oldPassword)
```
    Protects worksheet.
    This method can protect worksheet in all versions of Excel file.
    Parameters:
    type: int - A ProtectionType value. Protection type.
    password: String - Password.
    oldPassword: String - If the worksheet is already protected by a password, please supply the old password. Otherwise, you can set a null value or blank string to this parameter.
    Example:
    # Instantiating a Workbook object excel = Workbook("Book2.xlsx") # Accessing the first worksheet in the Excel file worksheet = excel.getWorksheets().get(0) # Protecting the worksheet with a password worksheet.protect(ProtectionType.ALL, "aspose", None) # Saving the modified Excel file in default (that is Excel 20003) format excel.save("Book1.xls")
  - unprotect
```
 unprotect()
```
    Unprotects worksheet.
    This method unprotects worksheet which is protected without password.
  - unprotect
```
 unprotect(password)
```
    Unprotects worksheet.
    If the worksheet is protected without a password, you can set a null value or blank string to password parameter.
    Parameters:
    password: String - Password
  - moveTo
```
 moveTo(index)
```
    Moves the sheet to another location in the spreadsheet.
    Parameters:
    index: int - Destination sheet index.

asposecells.api

Classes

Constants

Class Worksheet

Property Getters/Setters Detail

getProtection : Protection

getUniqueId/setUniqueId : String

getWorkbook : Workbook

getCells : Cells

getQueryTables : QueryTableCollection

getPivotTables : PivotTableCollection

getType/setType : int

getName/setName : String

getShowFormulas/setShowFormulas : boolean

isGridlinesVisible/setGridlinesVisible : boolean

isRowColumnHeadersVisible/setRowColumnHeadersVisible : boolean

getPaneState : int

getDisplayZeros/setDisplayZeros : boolean

getDisplayRightToLeft/setDisplayRightToLeft : boolean

isOutlineShown/setOutlineShown : boolean

isSelected/setSelected : boolean

getListObjects : ListObjectCollection

getTabId/setTabId : int

getHorizontalPageBreaks : HorizontalPageBreakCollection

getVerticalPageBreaks : VerticalPageBreakCollection

getHyperlinks : HyperlinkCollection

getPageSetup : PageSetup

getAutoFilter : AutoFilter

hasAutofilter : boolean

getTransitionEvaluation/setTransitionEvaluation : boolean

getTransitionEntry/setTransitionEntry : boolean

getVisibilityType/setVisibilityType : int

isVisible/setVisible : boolean

getSparklineGroups : SparklineGroupCollection

getCharts : ChartCollection

getComments : CommentCollection

getPictures : PictureCollection

getTextBoxes : TextBoxCollection

getCheckBoxes : CheckBoxCollection

getOleObjects : OleObjectCollection

getShapes : ShapeCollection

getSlicers : SlicerCollection

getTimelines : TimelineCollection

getIndex : int

isProtected : boolean

getValidations : ValidationCollection

getAllowEditRanges : ProtectedRangeCollection

getErrorCheckOptions : ErrorCheckOptionCollection

getOutline : Outline

getFirstVisibleRow/setFirstVisibleRow : int

getFirstVisibleColumn/setFirstVisibleColumn : int

getZoom/setZoom : int

getViewType/setViewType : int

isPageBreakPreview/setPageBreakPreview : boolean

isRulerVisible/setRulerVisible : boolean

getTabColor/setTabColor : Color

getCodeName/setCodeName : String

getBackgroundImage/setBackgroundImage : byte[]

getConditionalFormattings : ConditionalFormattingCollection

getActiveCell/setActiveCell : String

getCustomProperties : CustomPropertyCollection

getSmartTagSetting : SmartTagSetting

getScenarios : ScenarioCollection

getCellWatches : CellWatchCollection

Method Detail

replace

getSelectedRanges

getPrintingPageBreaks

toString

startAccessCache

closeAccessCache

convertFormulaReferenceStyle

calculateFormula

calculateFormula

calculateFormula

calculateArrayFormula

calculateArrayFormula

calculateArrayFormula

calculateFormula

xmlMapQuery