Worksheet
Inheritance: java.lang.Object
public class Worksheet
Encapsulates the object that represents a single worksheet.
Workbook workbook = new Workbook();
Worksheet 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");
Methods
| Method | Description |
|---|---|
| addPageBreaks(String cellName) | Adds page break. |
| advancedFilter(boolean isFilter, String listRange, String criteriaRange, String copyTo, boolean uniqueRecordOnly) | Filters data using complex criteria. |
| autoFitColumn(int columnIndex) | Autofits the column width. |
| autoFitColumn(int columnIndex, int firstRow, int lastRow) | Autofits the column width. |
| autoFitColumns() | Autofits all columns in this worksheet. |
| autoFitColumns(AutoFitterOptions options) | Autofits all columns in this worksheet. |
| autoFitColumns(int firstColumn, int lastColumn) | Autofits the columns width. |
| autoFitColumns(int firstColumn, int lastColumn, AutoFitterOptions options) | Autofits the columns width. |
| autoFitColumns(int firstRow, int firstColumn, int lastRow, int lastColumn) | Autofits the columns width. |
| autoFitColumns(int firstRow, int firstColumn, int lastRow, int lastColumn, AutoFitterOptions options) | Autofits the columns width. |
| autoFitRow(int rowIndex) | Autofits the row height. |
| autoFitRow(int rowIndex, int firstColumn, int lastColumn) | Autofits the row height. |
| autoFitRow(int rowIndex, int firstColumn, int lastColumn, AutoFitterOptions options) | Autofits the row height. |
| autoFitRow(int startRow, int endRow, int startColumn, int endColumn) | Autofits row height in a rectangle range. |
| autoFitRows() | Autofits all rows in this worksheet. |
| autoFitRows(boolean onlyAuto) | Autofits all rows in this worksheet. |
| autoFitRows(AutoFitterOptions options) | Autofits all rows in this worksheet. |
| autoFitRows(int startRow, int endRow) | Autofits row height in a range. |
| autoFitRows(int startRow, int endRow, AutoFitterOptions options) | Autofits row height in a range. |
| calculateFormula(boolean recursive, boolean ignoreError, ICustomFunction customFunction) | Calculates all formulas in this worksheet. |
| calculateFormula(CalculationOptions options, boolean recursive) | Calculates all formulas in this worksheet. |
| calculateFormula(String formula) | Calculates a formula. |
| calculateFormula(String formula, CalculationOptions opts) | Calculates a formula. |
| clearComments() | Clears all comments in designer spreadsheet. |
| closeAccessCache(int opts) | Closes the session that uses caches to access the data in this worksheet. |
| copy(Worksheet sourceSheet) | Copies contents and formats from another worksheet. |
| copy(Worksheet sourceSheet, CopyOptions copyOptions) | Copies contents and formats from another worksheet. |
| dispose() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| equals(Object arg0) | |
| freezePanes(int row, int column, int freezedRows, int freezedColumns) | Freezes panes at the specified cell in the worksheet. |
| freezePanes(String cellName, int freezedRows, int freezedColumns) | Freezes panes at the specified cell in the worksheet. |
| getActiveCell() | Gets the active cell in the worksheet. |
| getAllowEditRanges() | Gets the allow edit range collection in the worksheet. |
| getAutoFilter() | Represents auto filter for the specified worksheet. |
| getBackgroundImage() | Gets worksheet background image. |
| getCellWatches() | Gets collection of cells on this worksheet being watched in the ‘watch window’. |
| getCells() | Gets the Cells collection. |
| getCharts() | Gets a Chart collection |
| getCheckBoxes() | Gets a CheckBox collection. |
| getClass() | |
| getCodeName() | Gets worksheet code name. |
| getComments() | Gets the Comment collection. |
| getConditionalFormattings() | Gets the ConditionalFormattings in the worksheet. |
| getCustomProperties() | Gets an object representing the identifier information associated with a worksheet. |
| getDisplayRightToLeft() | Indicates if the specified worksheet is displayed from right to left instead of from left to right. |
| getDisplayZeros() | True if zero values are displayed. |
| getErrorCheckOptions() | Gets error check setting applied on certain ranges. |
| getFirstVisibleColumn() | Represents first visible column index. |
| getFirstVisibleRow() | Represents first visible row index. |
| getFreezedPanes() | Gets the freeze panes. |
| getHorizontalPageBreaks() | Gets the HorizontalPageBreakCollection collection. |
| getHyperlinks() | Gets the HyperlinkCollection collection. |
| getIndex() | Gets the index of sheet in the worksheet collection. |
| getListObjects() | Gets all ListObjects in this worksheet. |
| getName() | Gets the name of the worksheet. |
| getOleObjects() | Represents a collection of OleObject in a worksheet. |
| getOutline() | Gets the outline on this worksheet. |
| getPageSetup() | Represents the page setup description in this sheet. |
| getPaneState() | Indicates whether the pane has horizontal or vertical splits, and whether those splits are frozen. |
| getPanes() | Gets the window panes. |
| getPictures() | Gets a Picture collection. |
| getPivotTables() | Gets all pivot tables in this worksheet. |
| getPrintingPageBreaks(ImageOrPrintOptions options) | Gets automatic page breaks. |
| getProtection() | Represents the various types of protection options available for a worksheet. |
| getQueryTables() | Gets QueryTableCollection in the worksheet. |
| getScenarios() | Gets the collection of Scenario. |
| getSelectedRanges() | Gets selected ranges of cells in the designer spreadsheet. |
| getShapes() | Returns all drawing shapes in this worksheet. |
| getShowFormulas() | Indicates whether to show formulas or their results. |
| getSlicers() | Get the Slicer collection in the worksheet |
| getSmartTagSetting() | Gets all SmartTagCollection objects of the worksheet. |
| getSparklineGroupCollection() | Gets the sparkline group collection in the worksheet. |
| getSparklineGroups() | Gets the sparkline groups in the worksheet. |
| getTabColor() | Represents worksheet tab color. |
| getTabId() | Specifies the internal identifier for the sheet. |
| getTextBoxes() | Gets a TextBox collection. |
| getTimelines() | Get the Timeline collection in the worksheet |
| getTransitionEntry() | Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled. |
| getTransitionEvaluation() | Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled. |
| getType() | Represents worksheet type. |
| getUniqueId() | Gets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}. |
| getValidations() | Gets the data validation setting collection in the worksheet. |
| getVerticalPageBreaks() | Gets the VerticalPageBreakCollection collection. |
| getViewType() | Gets the view type. |
| getVisibilityType() | Indicates the visible state for this sheet. |
| getWorkbook() | Gets the workbook object which contains this sheet. |
| getZoom() | Represents the scaling factor in percentage. |
| hasAutofilter() | Indicates whether this worksheet has auto filter. |
| hashCode() | |
| isGridlinesVisible() | Gets a value indicating whether the gridlines are visible.Default is true. |
| isOutlineShown() | Indicates whether to show outline. |
| isPageBreakPreview() | Indicates whether the specified worksheet is shown in normal view or page break preview. |
| isProtected() | Indicates if the worksheet is protected. |
| isRowColumnHeadersVisible() | Gets a value indicating whether the worksheet will display row and column headers. |
| isRulerVisible() | Indicates whether the ruler is visible. |
| isSelected() | Indicates whether this worksheet is selected when the workbook is opened. |
| isVisible() | Represents if the worksheet is visible. |
| moveTo(int index) | Moves the sheet to another location in the spreadsheet. |
| notify() | |
| notifyAll() | |
| protect(int type) | Protects worksheet. |
| protect(int type, String password, String oldPassword) | Protects worksheet. |
| refreshPivotTables() | Refreshes all the PivotTables in this Worksheet. |
| removeAllDrawingObjects() | Removes all drawing objects in this worksheet. |
| removeAutoFilter() | Removes the auto filter of the worksheet. |
| removeSplit() | Removes split window. |
| replace(String oldString, String newString) | Replaces all cells’ text with a new string. |
| selectRange(int startRow, int startColumn, int totalRows, int totalColumns, boolean removeOthers) | Selects a range. |
| setActiveCell(String value) | Sets the active cell in the worksheet. |
| setBackground(byte[] pictureData) | Sets worksheet background image. |
| setBackgroundImage(byte[] value) | Sets worksheet background image. |
| setCodeName(String value) | Gets worksheet code name. |
| setDisplayRightToLeft(boolean value) | Indicates if the specified worksheet is displayed from right to left instead of from left to right. |
| setDisplayZeros(boolean value) | True if zero values are displayed. |
| setFirstVisibleColumn(int value) | Represents first visible column index. |
| setFirstVisibleRow(int value) | Represents first visible row index. |
| setGridlinesVisible(boolean value) | Sets a value indicating whether the gridlines are visible.Default is true. |
| setName(String value) | Sets the name of the worksheet. |
| setOutlineShown(boolean value) | Indicates whether to show outline. |
| setPageBreakPreview(boolean value) | Indicates whether the specified worksheet is shown in normal view or page break preview. |
| setRowColumnHeadersVisible(boolean value) | Sets a value indicating whether the worksheet will display row and column headers. |
| setRulerVisible(boolean value) | Indicates whether the ruler is visible. |
| setSelected(boolean value) | Indicates whether this worksheet is selected when the workbook is opened. |
| setShowFormulas(boolean value) | Indicates whether to show formulas or their results. |
| setTabColor(Color value) | Represents worksheet tab color. |
| setTabId(int value) | Specifies the internal identifier for the sheet. |
| setTransitionEntry(boolean value) | Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled. |
| setTransitionEvaluation(boolean value) | Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled. |
| setType(int value) | Represents worksheet type. |
| setUniqueId(String value) | Sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}. |
| setViewType(int value) | Sets the view type. |
| setVisibilityType(int value) | Indicates the visible state for this sheet. |
| setVisible(boolean value) | Represents if the worksheet is visible. |
| setVisible(boolean isVisible, boolean ignoreError) | Sets the visible options. |
| setZoom(int value) | Represents the scaling factor in percentage. |
| split() | Splits window. |
| startAccessCache(int opts) | Starts the session that uses caches to access the data in this worksheet. |
| toString() | Returns a string represents the current Worksheet object. |
| unFreezePanes() | Unfreezes panes in the worksheet. |
| unprotect() | Unprotects worksheet. |
| unprotect(String password) | Unprotects worksheet. |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) | |
| xmlMapQuery(String path, XmlMap xmlMap) | Query cell areas that mapped/linked to the specific path of xml map. |
addPageBreaks(String cellName)
public void addPageBreaks(String cellName)
Adds page break.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| cellName | java.lang.String |
advancedFilter(boolean isFilter, String listRange, String criteriaRange, String copyTo, boolean uniqueRecordOnly)
public void advancedFilter(boolean isFilter, String listRange, String criteriaRange, String copyTo, boolean uniqueRecordOnly)
Filters data using complex criteria.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| isFilter | boolean | Indicates whether filtering the list in place. |
| listRange | java.lang.String | The list range. |
| criteriaRange | java.lang.String | The criteria range. |
| copyTo | java.lang.String | The range where copying data to. |
| uniqueRecordOnly | boolean | Only displaying or copying unique rows. |
autoFitColumn(int columnIndex)
public void autoFitColumn(int columnIndex)
Autofits the column width. AutoFitColumn is an imprecise function.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| columnIndex | int | Column index. |
autoFitColumn(int columnIndex, int firstRow, int lastRow)
public void autoFitColumn(int columnIndex, int firstRow, int lastRow)
Autofits the column width. This method autofits a row based on content in a range of cells within the row.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| columnIndex | int | Column index. |
| firstRow | int | First row index. |
| lastRow | int | Last row index. |
autoFitColumns()
public void autoFitColumns()
Autofits all columns in this worksheet.
autoFitColumns(AutoFitterOptions options)
public void autoFitColumns(AutoFitterOptions options)
Autofits all columns in this worksheet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | AutoFitterOptions | The auto fitting options |
autoFitColumns(int firstColumn, int lastColumn)
public void autoFitColumns(int firstColumn, int lastColumn)
Autofits the columns width. AutoFitColumn is an imprecise function.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| firstColumn | int | First column index. |
| lastColumn | int | Last column index. |
autoFitColumns(int firstColumn, int lastColumn, AutoFitterOptions options)
public void autoFitColumns(int firstColumn, int lastColumn, AutoFitterOptions options)
Autofits the columns width. AutoFitColumn is an imprecise function.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| firstColumn | int | First column index. |
| lastColumn | int | Last column index. |
| options | AutoFitterOptions | The auto fitting options |
autoFitColumns(int firstRow, int firstColumn, int lastRow, int lastColumn)
public void autoFitColumns(int firstRow, int firstColumn, int lastRow, int lastColumn)
Autofits the columns width. AutoFitColumn is an imprecise function.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| firstRow | int | First row index. |
| firstColumn | int | First column index. |
| lastRow | int | Last row index. |
| lastColumn | int | Last column index. |
autoFitColumns(int firstRow, int firstColumn, int lastRow, int lastColumn, AutoFitterOptions options)
public void autoFitColumns(int firstRow, int firstColumn, int lastRow, int lastColumn, AutoFitterOptions options)
Autofits the columns width. AutoFitColumn is an imprecise function.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| 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(int rowIndex)
public void autoFitRow(int rowIndex)
Autofits the row height. AutoFitRow is an imprecise function.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rowIndex | int | Row index. |
autoFitRow(int rowIndex, int firstColumn, int lastColumn)
public void autoFitRow(int rowIndex, int firstColumn, int lastColumn)
Autofits the row height. This method autofits a row based on content in a range of cells within the row.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rowIndex | int | Row index. |
| firstColumn | int | First column index. |
| lastColumn | int | Last column index. |
autoFitRow(int rowIndex, int firstColumn, int lastColumn, AutoFitterOptions options)
public void autoFitRow(int rowIndex, int firstColumn, int lastColumn, AutoFitterOptions options)
Autofits the row height. This method autofits a row based on content in a range of cells within the row.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rowIndex | int | Row index. |
| firstColumn | int | First column index. |
| lastColumn | int | Last column index. |
| options | AutoFitterOptions | The auto fitter options |
autoFitRow(int startRow, int endRow, int startColumn, int endColumn)
public void autoFitRow(int startRow, int endRow, int startColumn, int endColumn)
Autofits row height in a rectangle range.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startRow | int | Start row index. |
| endRow | int | End row index. |
| startColumn | int | Start column index. |
| endColumn | int | End column index. |
autoFitRows()
public void autoFitRows()
Autofits all rows in this worksheet.
autoFitRows(boolean onlyAuto)
public void autoFitRows(boolean onlyAuto)
Autofits all rows in this worksheet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| onlyAuto | boolean | True,only autofits the row height when row height is not customed. |
autoFitRows(AutoFitterOptions options)
public void autoFitRows(AutoFitterOptions options)
Autofits all rows in this worksheet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | AutoFitterOptions | The auto fitter options |
autoFitRows(int startRow, int endRow)
public void autoFitRows(int startRow, int endRow)
Autofits row height in a range.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startRow | int | Start row index. |
| endRow | int | End row index. |
autoFitRows(int startRow, int endRow, AutoFitterOptions options)
public void autoFitRows(int startRow, int endRow, AutoFitterOptions options)
Autofits row height in a range.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startRow | int | Start row index. |
| endRow | int | End row index. |
| options | AutoFitterOptions | The options of auto fitter. |
calculateFormula(boolean recursive, boolean ignoreError, ICustomFunction customFunction)
public void calculateFormula(boolean recursive, boolean ignoreError, ICustomFunction customFunction)
Calculates all formulas in this worksheet. NOTE: This member is now obsolete. Instead, please use CalculateFormula(CalculationOptions, bool) method. This method will be removed 12 months later since August 2020. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| 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. |
| ignoreError | boolean | Indicates if hide the error in calculating formulas. The error may be unsupported function, external links, etc. |
| customFunction | ICustomFunction | The custom formula calculation functions to extend the calculation engine. |
calculateFormula(CalculationOptions options, boolean recursive)
public void calculateFormula(CalculationOptions options, boolean recursive)
Calculates all formulas in this worksheet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| 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. |
calculateFormula(String formula)
public Object calculateFormula(String formula)
Calculates a formula.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| formula | java.lang.String | Formula to be calculated. |
Returns: java.lang.Object - Calculated formula result.
calculateFormula(String formula, CalculationOptions opts)
public Object calculateFormula(String formula, CalculationOptions opts)
Calculates a formula.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| formula | java.lang.String | Formula to be calculated. |
| opts | CalculationOptions | Options for calculating formula |
Returns: java.lang.Object - Calculated formula result.
clearComments()
public void clearComments()
Clears all comments in designer spreadsheet.
closeAccessCache(int opts)
public void closeAccessCache(int opts)
Closes the session that uses caches to access the data in this worksheet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| opts | int | options of data access |
copy(Worksheet sourceSheet)
public void copy(Worksheet sourceSheet)
Copies contents and formats from another worksheet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sourceSheet | Worksheet | Source worksheet. |
copy(Worksheet sourceSheet, CopyOptions copyOptions)
public void copy(Worksheet sourceSheet, CopyOptions 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:
| Parameter | Type | Description |
|---|---|---|
| sourceSheet | Worksheet | Source worksheet. |
| copyOptions | CopyOptions |
dispose()
public void dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
freezePanes(int row, int column, int freezedRows, int freezedColumns)
public void freezePanes(int row, int column, int freezedRows, int 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:
| Parameter | Type | Description |
|---|---|---|
| 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. |
freezePanes(String cellName, int freezedRows, int freezedColumns)
public void freezePanes(String cellName, int freezedRows, int 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:
| Parameter | Type | Description |
|---|---|---|
| cellName | java.lang.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. |
getActiveCell()
public String getActiveCell()
Gets the active cell in the worksheet.
Returns: java.lang.String
getAllowEditRanges()
public ProtectedRangeCollection getAllowEditRanges()
Gets the allow edit range collection in the worksheet.
Returns: ProtectedRangeCollection
getAutoFilter()
public AutoFilter getAutoFilter()
Represents auto filter for the specified worksheet.
Returns: AutoFilter
getBackgroundImage()
public byte[] getBackgroundImage()
Gets worksheet background image.
Returns: byte[]
getCellWatches()
public CellWatchCollection getCellWatches()
Gets collection of cells on this worksheet being watched in the ‘watch window’.
Returns: CellWatchCollection
getCells()
public Cells getCells()
Gets the Cells collection.
Returns: Cells
getCharts()
public ChartCollection getCharts()
Gets a Chart collection
Returns: ChartCollection
getCheckBoxes()
public CheckBoxCollection getCheckBoxes()
Gets a CheckBox collection.
Returns: CheckBoxCollection
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getCodeName()
public String getCodeName()
Gets worksheet code name.
Returns: java.lang.String
getComments()
public CommentCollection getComments()
Gets the Comment collection.
Returns: CommentCollection
getConditionalFormattings()
public ConditionalFormattingCollection getConditionalFormattings()
Gets the ConditionalFormattings in the worksheet.
Returns: ConditionalFormattingCollection
getCustomProperties()
public 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.
Returns: CustomPropertyCollection
getDisplayRightToLeft()
public boolean getDisplayRightToLeft()
Indicates if the specified worksheet is displayed from right to left instead of from left to right. Default is false.
Returns: boolean
getDisplayZeros()
public boolean getDisplayZeros()
True if zero values are displayed.
Returns: boolean
getErrorCheckOptions()
public ErrorCheckOptionCollection getErrorCheckOptions()
Gets error check setting applied on certain ranges.
Returns: ErrorCheckOptionCollection
getFirstVisibleColumn()
public int getFirstVisibleColumn()
Represents first visible column index.
Returns: int
getFirstVisibleRow()
public int getFirstVisibleRow()
Represents first visible row index.
Returns: int
getFreezedPanes()
public int[] getFreezedPanes()
Gets the freeze panes.
Returns: int[] - Return null means the worksheet is not frozen 0:Row index;1:column;2:freezedRows;3:freezedRows
getHorizontalPageBreaks()
public HorizontalPageBreakCollection getHorizontalPageBreaks()
Gets the HorizontalPageBreakCollection collection.
Returns: HorizontalPageBreakCollection
getHyperlinks()
public HyperlinkCollection getHyperlinks()
Gets the HyperlinkCollection collection.
Returns: HyperlinkCollection
getIndex()
public int getIndex()
Gets the index of sheet in the worksheet collection.
Returns: int
getListObjects()
public ListObjectCollection getListObjects()
Gets all ListObjects in this worksheet.
Returns: ListObjectCollection
getName()
public String getName()
Gets 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.
Returns: java.lang.String
getOleObjects()
public OleObjectCollection getOleObjects()
Represents a collection of OleObject in a worksheet.
Returns: OleObjectCollection
getOutline()
public Outline getOutline()
Gets the outline on this worksheet.
Returns: Outline
getPageSetup()
public PageSetup getPageSetup()
Represents the page setup description in this sheet.
Returns: PageSetup
getPaneState()
public int getPaneState()
Indicates whether the pane has horizontal or vertical splits, and whether those splits are frozen.
Returns: int
getPanes()
public PaneCollection getPanes()
Gets the window panes. If the window is not split or frozen.
Returns: PaneCollection
getPictures()
public PictureCollection getPictures()
Gets a Picture collection.
Returns: PictureCollection
getPivotTables()
public PivotTableCollection getPivotTables()
Gets all pivot tables in this worksheet.
Returns: PivotTableCollection
getPrintingPageBreaks(ImageOrPrintOptions options)
public CellArea[] getPrintingPageBreaks(ImageOrPrintOptions options)
Gets automatic page breaks. Each cell area represents a paper.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | ImageOrPrintOptions | The print options |
Returns: com.aspose.cells.CellArea[] - The automatic page breaks areas.
getProtection()
public 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.
Returns: Protection
getQueryTables()
public QueryTableCollection getQueryTables()
Gets QueryTableCollection in the worksheet.
Returns: QueryTableCollection
getScenarios()
public ScenarioCollection getScenarios()
Gets the collection of Scenario.
Returns: ScenarioCollection
getSelectedRanges()
public ArrayList getSelectedRanges()
Gets selected ranges of cells in the designer spreadsheet.
Returns: java.util.ArrayList - An ArrayList which contains selected ranges.
getShapes()
public ShapeCollection getShapes()
Returns all drawing shapes in this worksheet.
Returns: ShapeCollection
getShowFormulas()
public boolean getShowFormulas()
Indicates whether to show formulas or their results.
Returns: boolean
getSlicers()
public SlicerCollection getSlicers()
Get the Slicer collection in the worksheet
Returns: SlicerCollection
getSmartTagSetting()
public SmartTagSetting getSmartTagSetting()
Gets all SmartTagCollection objects of the worksheet.
Returns: SmartTagSetting
getSparklineGroupCollection()
public SparklineGroupCollection getSparklineGroupCollection()
Gets the sparkline group collection in the worksheet. NOTE: This member is now obsolete. Instead, please use Worksheet.SparklineGroups property. This property will be removed 12 months later since November 2022. Aspose apologizes for any inconvenience you may have experienced.
Returns: SparklineGroupCollection
getSparklineGroups()
public SparklineGroupCollection getSparklineGroups()
Gets the sparkline groups in the worksheet.
Returns: SparklineGroupCollection
getTabColor()
public Color getTabColor()
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.
Returns: Color
getTabId()
public int getTabId()
Specifies the internal identifier for the sheet.
Returns: int
getTextBoxes()
public TextBoxCollection getTextBoxes()
Gets a TextBox collection.
Returns: TextBoxCollection
getTimelines()
public TimelineCollection getTimelines()
Get the Timeline collection in the worksheet
Returns: TimelineCollection
getTransitionEntry()
public boolean getTransitionEntry()
Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.
Returns: boolean
getTransitionEvaluation()
public boolean getTransitionEvaluation()
Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.
Returns: boolean
getType()
public int getType()
Represents worksheet type.
Returns: int
getUniqueId()
public String getUniqueId()
Gets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}.
Returns: java.lang.String
getValidations()
public ValidationCollection getValidations()
Gets the data validation setting collection in the worksheet.
Returns: ValidationCollection
getVerticalPageBreaks()
public VerticalPageBreakCollection getVerticalPageBreaks()
Gets the VerticalPageBreakCollection collection.
Returns: VerticalPageBreakCollection
getViewType()
public int getViewType()
Gets the view type.
Returns: int
getVisibilityType()
public int getVisibilityType()
Indicates the visible state for this sheet.
Returns: int
getWorkbook()
public Workbook getWorkbook()
Gets the workbook object which contains this sheet.
Returns: Workbook
getZoom()
public int getZoom()
Represents the scaling factor in percentage. It should be between 10 and 400. Please set the view type first.
Returns: int
hasAutofilter()
public boolean hasAutofilter()
Indicates whether this worksheet has auto filter.
Returns: boolean
hashCode()
public native int hashCode()
Returns: int
isGridlinesVisible()
public boolean isGridlinesVisible()
Gets a value indicating whether the gridlines are visible.Default is true.
Returns: boolean
isOutlineShown()
public boolean isOutlineShown()
Indicates whether to show outline.
Returns: boolean
isPageBreakPreview()
public boolean isPageBreakPreview()
Indicates whether the specified worksheet is shown in normal view or page break preview.
Returns: boolean
isProtected()
public boolean isProtected()
Indicates if the worksheet is protected.
Returns: boolean
isRowColumnHeadersVisible()
public boolean isRowColumnHeadersVisible()
Gets a value indicating whether the worksheet will display row and column headers. Default is true.
Returns: boolean
isRulerVisible()
public boolean isRulerVisible()
Indicates whether the ruler is visible. This property is only applied for page break preview.
Returns: boolean
isSelected()
public boolean isSelected()
Indicates whether this worksheet is selected when the workbook is opened.
Returns: boolean
isVisible()
public boolean isVisible()
Represents if the worksheet is visible.
Returns: boolean
moveTo(int index)
public void moveTo(int index)
Moves the sheet to another location in the spreadsheet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | int | Destination sheet index. |
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
protect(int type)
public void protect(int type)
Protects worksheet. This method protects worksheet without password. It can protect worksheet in all versions of Excel file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | int | Protection type. |
protect(int type, String password, String oldPassword)
public void protect(int type, String password, String oldPassword)
Protects worksheet. This method can protect worksheet in all versions of Excel file.
//Instantiating a Workbook object
Workbook excel = new Workbook("template.xlsx");
//Accessing the first worksheet in the Excel file
Worksheet worksheet = excel.getWorksheets().get(0);
//Protecting the worksheet with a password
worksheet.protect(ProtectionType.ALL, "aspose", null);
//Saving the modified Excel file in default (that is Excel 20003) format
excel.save("output.xls");
//Closing the file stream to free all resources
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | int | Protection type. |
| password | java.lang.String | Password. |
| oldPassword | java.lang.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. |
refreshPivotTables()
public void refreshPivotTables()
Refreshes all the PivotTables in this Worksheet.
removeAllDrawingObjects()
public void removeAllDrawingObjects()
Removes all drawing objects in this worksheet.
removeAutoFilter()
public void removeAutoFilter()
Removes the auto filter of the worksheet.
removeSplit()
public void removeSplit()
Removes split window.
replace(String oldString, String newString)
public int replace(String oldString, String newString)
Replaces all cells’ text with a new string.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| oldString | java.lang.String | Old string value. |
| newString | java.lang.String | New string value. |
Returns: int
selectRange(int startRow, int startColumn, int totalRows, int totalColumns, boolean removeOthers)
public void selectRange(int startRow, int startColumn, int totalRows, int totalColumns, boolean removeOthers)
Selects a range.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| 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. |
setActiveCell(String value)
public void setActiveCell(String value)
Sets the active cell in the worksheet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setBackground(byte[] pictureData)
public void setBackground(byte[] pictureData)
Sets worksheet background image. NOTE: This member is now obsolete. Instead, please use Worksheet.BackgroundImage property. This property will be removed 12 months later since August 2016. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pictureData | byte[] | Picture data. |
setBackgroundImage(byte[] value)
public void setBackgroundImage(byte[] value)
Sets worksheet background image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte[] |
setCodeName(String value)
public void setCodeName(String value)
Gets worksheet code name.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setDisplayRightToLeft(boolean value)
public void setDisplayRightToLeft(boolean value)
Indicates if the specified worksheet is displayed from right to left instead of from left to right. Default is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setDisplayZeros(boolean value)
public void setDisplayZeros(boolean value)
True if zero values are displayed.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setFirstVisibleColumn(int value)
public void setFirstVisibleColumn(int value)
Represents first visible column index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setFirstVisibleRow(int value)
public void setFirstVisibleRow(int value)
Represents first visible row index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setGridlinesVisible(boolean value)
public void setGridlinesVisible(boolean value)
Sets a value indicating whether the gridlines are visible.Default is true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setName(String value)
public void setName(String value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setOutlineShown(boolean value)
public void setOutlineShown(boolean value)
Indicates whether to show outline.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setPageBreakPreview(boolean value)
public void setPageBreakPreview(boolean value)
Indicates whether the specified worksheet is shown in normal view or page break preview.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setRowColumnHeadersVisible(boolean value)
public void setRowColumnHeadersVisible(boolean value)
Sets a value indicating whether the worksheet will display row and column headers. Default is true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setRulerVisible(boolean value)
public void setRulerVisible(boolean value)
Indicates whether the ruler is visible. This property is only applied for page break preview.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSelected(boolean value)
public void setSelected(boolean value)
Indicates whether this worksheet is selected when the workbook is opened.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setShowFormulas(boolean value)
public void setShowFormulas(boolean value)
Indicates whether to show formulas or their results.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setTabColor(Color value)
public void setTabColor(Color 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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color |
setTabId(int value)
public void setTabId(int value)
Specifies the internal identifier for the sheet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setTransitionEntry(boolean value)
public void setTransitionEntry(boolean value)
Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setTransitionEvaluation(boolean value)
public void setTransitionEvaluation(boolean value)
Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setType(int value)
public void setType(int value)
Represents worksheet type.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setUniqueId(String value)
public void setUniqueId(String value)
Sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setViewType(int value)
public void setViewType(int value)
Sets the view type.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setVisibilityType(int value)
public void setVisibilityType(int value)
Indicates the visible state for this sheet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setVisible(boolean value)
public void setVisible(boolean value)
Represents if the worksheet is visible.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setVisible(boolean isVisible, boolean ignoreError)
public void setVisible(boolean isVisible, boolean ignoreError)
Sets the visible options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| isVisible | boolean | Whether the worksheet is visible |
| ignoreError | boolean | Whether to ignore error if this option is not valid. |
setZoom(int value)
public void setZoom(int value)
Represents the scaling factor in percentage. It should be between 10 and 400. Please set the view type first.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
split()
public void split()
Splits window.
startAccessCache(int opts)
public void startAccessCache(int opts)
Starts the session that uses caches to access the data in this worksheet. After finishing the access to the data, Workbook.closeAccessCache(int) should be invoked with same options to clear all caches and recover normal access mode.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| opts | int | options of data access |
toString()
public String toString()
Returns a string represents the current Worksheet object.
Returns: java.lang.String -
unFreezePanes()
public void unFreezePanes()
Unfreezes panes in the worksheet.
unprotect()
public void unprotect()
Unprotects worksheet. This method unprotects worksheet which is protected without password.
unprotect(String password)
public void unprotect(String password)
Unprotects worksheet. If the worksheet is protected without a password, you can set a null value or blank string to password parameter.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| password | java.lang.String | Password |
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |
xmlMapQuery(String path, XmlMap xmlMap)
public ArrayList xmlMapQuery(String path, XmlMap xmlMap)
Query cell areas that mapped/linked to the specific path of xml map.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | java.lang.String | xml element path |
| xmlMap | XmlMap | Specify an xml map if you want to query for the specific path within a specific map |
Returns: java.util.ArrayList - CellArea list that mapped/linked to the specific path of xml map, an empty list is returned if nothing is mapped/linked.