com.aspose.cells.Worksheet.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aspose-cells Show documentation

Aspose.Cells for Java

There is a newer version: 23.1






Worksheet





com.aspose.cells

Class Worksheet
java.lang.Object
    com.aspose.cells.Worksheet



public class Worksheet extends java.lang.Object





             Encapsulates the object that represents a single worksheet.
             
Example:
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");












Property Getters/Setters Summary



java.lang.String getActiveCell() 
void setActiveCell(java.lang.String) 
          
            Gets or sets the active cell in the worksheet. 
            



ProtectedRangeCollection getAllowEditRanges() 
          
            Gets the allow edit range collection in the worksheet.
            



AutoFilter getAutoFilter() 
          
            Represents auto filter for the specified worksheet.
            



byte[] getBackgroundImage() 
void setBackgroundImage(byte[]) 
          
            Gets and sets worksheet background image.
            



Cells getCells() 
          
            Gets the Cells collection.
            



CellWatchCollection getCellWatches() 
          
            Gets collection of cells on this worksheet being watched in the 'watch window'.
            



ChartCollection getCharts() 
          
            Gets a Chart collection
            



CheckBoxCollection getCheckBoxes() 
          
            Gets a CheckBox collection.
            



java.lang.String getCodeName() 
void setCodeName(java.lang.String) 
          
            Gets worksheet code name.
            



CommentCollection getComments() 
          
            Gets the Comment collection.
            



ConditionalFormattingCollection getConditionalFormattings() 
          
            Gets the ConditionalFormattings in the worksheet.
            



CustomPropertyCollection getCustomProperties() 
          
            Gets an object representing 
            the identifier information associated with a worksheet. 
            



boolean getDisplayRightToLeft() 
void setDisplayRightToLeft(boolean) 
          
            Indicates if the specified worksheet is displayed from right to left instead of from left to right.
            Default is false.
            



boolean getDisplayZeros() 
void setDisplayZeros(boolean) 
          
            True if zero values are displayed. 
            



ErrorCheckOptionCollection getErrorCheckOptions() 
          
            Gets error check setting applied on certain ranges.
            



int getFirstVisibleColumn() 
void setFirstVisibleColumn(int) 
          
            Represents first visible column index.
            



int getFirstVisibleRow() 
void setFirstVisibleRow(int) 
          
            Represents first visible row index.
            



boolean hasAutofilter() 
          
            Indicates whether this worksheet has auto filter.
            



HorizontalPageBreakCollection getHorizontalPageBreaks() 
          
            Gets the HorizontalPageBreakCollection collection. 
            



HyperlinkCollection getHyperlinks() 
          
            Gets the HyperlinkCollection collection.
            



int getIndex() 
          
            Gets the index of sheet in the worksheet collection.
            



boolean isGridlinesVisible() 
void setGridlinesVisible(boolean) 
          
            Gets or sets a value indicating whether the gridlines are visible.Default is true.
            



boolean isOutlineShown() 
void setOutlineShown(boolean) 
          
            Indicates whether to show outline.
            



boolean isPageBreakPreview() 
void setPageBreakPreview(boolean) 
          
            Indicates whether the specified worksheet is shown in normal view or page break preview.
            



boolean isProtected() 
          
            Indicates if the worksheet is protected.
            



boolean isRowColumnHeadersVisible() 
void setRowColumnHeadersVisible(boolean) 
          
            Gets or sets a value indicating whether the worksheet will display row and column headers.
            Default is true.
            



boolean isRulerVisible() 
void setRulerVisible(boolean) 
          
            Indicates whether the ruler is visible. This property is only applied for page break preview.
            



boolean isSelected() 
void setSelected(boolean) 
          
            Indicates whether this worksheet is selected when the workbook is opened.
            



boolean isVisible() 
void setVisible(boolean) 
          
            Represents if the worksheet is visible.
            



ListObjectCollection getListObjects() 
          
            Gets all ListObjects in this worksheet.
            



java.lang.String getName() 
void setName(java.lang.String) 
          
            Gets or sets the name of the worksheet.
            



OleObjectCollection getOleObjects() 
          
            Represents a collection of OleObject in a worksheet.
            



Outline getOutline() 
          
            Gets the outline on this worksheet.
            



PageSetup getPageSetup() 
          
            Represents the page setup description in this sheet.
            



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.



PictureCollection getPictures() 
          
            Gets a Picture collection.
            



PivotTableCollection getPivotTables() 
          
            Gets all pivot tables in this worksheet.
            



Protection getProtection() 
          
            Represents the various types of protection options available for a worksheet. Supports advanced protection options in ExcelXP and above version.
            



QueryTableCollection getQueryTables() 
          
            Gets QueryTableCollection in the worksheet.
            



ScenarioCollection getScenarios() 
          
            Gets the collection of Scenario.
            



ShapeCollection getShapes() 
          
            Returns all drawing shapes in this worksheet.
            



boolean getShowFormulas() 
void setShowFormulas(boolean) 
          
            Indicates whether to show formulas or their results.
            



SlicerCollection getSlicers() 
          
            Get the Slicer collection in the worksheet
            



SmartTagSetting getSmartTagSetting() 
          
            Gets all SmartTagCollection objects of the worksheet.
            



SparklineGroupCollection getSparklineGroupCollection() 
          
            Gets the sparkline group collection in the worksheet.
            



com.aspose.cells.Color getTabColor() 
void setTabColor(com.aspose.cells.Color) 
          
            Represents worksheet tab color.
            



int getTabId() 
void setTabId(int) 
          
            Specifies the internal identifier for the sheet.
            



TextBoxCollection getTextBoxes() 
          
            Gets a TextBox collection.
            



TimelineCollection getTimelines() 
          
            Get the Timeline collection in the worksheet
            



boolean getTransitionEntry() 
void setTransitionEntry(boolean) 
          
            Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.
            



boolean getTransitionEvaluation() 
void setTransitionEvaluation(boolean) 
          
            Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.
            



int getType() 
void setType(int) 
          
            Represents worksheet type.
            The value of the property is SheetType integer constant.



java.lang.String getUniqueId() 
void setUniqueId(java.lang.String) 
          
            Gets and sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}.
            



ValidationCollection getValidations() 
          
            Gets the data validation setting collection in the worksheet.
            



VerticalPageBreakCollection getVerticalPageBreaks() 
          
            Gets the VerticalPageBreakCollection collection.
            



int getViewType() 
void setViewType(int) 
          
            Gets and sets the view type.
            The value of the property is ViewType integer constant.



int getVisibilityType() 
void setVisibilityType(int) 
          
            Indicates the visible state for this sheet.
            The value of the property is VisibilityType integer constant.



Workbook getWorkbook() 
          
            Gets the workbook object which contains this sheet.
            



int getZoom() 
void setZoom(int) 
          
            Represents the scaling factor in percentage. It should be between 10 and 400.
            

 







Method Summary




void addPageBreaks(java.lang.String cellName) 
          
            Adds page break.
            




void advancedFilter(boolean isFilter, java.lang.String listRange, java.lang.String criteriaRange, java.lang.String copyTo, boolean uniqueRecordOnly) 
          
            Filters data using complex criteria.
             




void autoFitColumn(int columnIndex) 
          
            Autofits the column width.
            




void autoFitColumn(int columnIndex, int firstRow, int lastRow) 
          
            Autofits the column width.
            




void autoFitColumns() 
          
            Autofits all columns in this worksheet.
            




void autoFitColumns(AutoFitterOptions options) 
          
            Autofits all columns in this worksheet.
            




void autoFitColumns(int firstColumn, int lastColumn) 
          
            Autofits the columns width.
            




void autoFitColumns(int firstColumn, int lastColumn, AutoFitterOptions options) 
          
            Autofits the columns width.
            




void autoFitColumns(int firstRow, int firstColumn, int lastRow, int lastColumn) 
          
            Autofits the columns width.
            




void autoFitColumns(int firstRow, int firstColumn, int lastRow, int lastColumn, AutoFitterOptions options) 
          
            Autofits the columns width.
            




void autoFitRow(int rowIndex) 
          
            Autofits the row height.
            




void autoFitRow(int rowIndex, int firstColumn, int lastColumn) 
          
            Autofits the row height.
            




void autoFitRow(int rowIndex, int firstColumn, int lastColumn, AutoFitterOptions options) 
          
            Autofits the row height.
            




void autoFitRow(int startRow, int endRow, int startColumn, int endColumn) 
          
            Autofits row height in a rectangle range.
            




void autoFitRows() 
          
            Autofits all rows in this worksheet.
            




void autoFitRows(boolean onlyAuto) 
          
            Autofits all rows in this worksheet.
            




void autoFitRows(AutoFitterOptions options) 
          
            Autofits all rows in this worksheet.
            




void autoFitRows(int startRow, int endRow) 
          
            Autofits row height in a range.
            




void autoFitRows(int startRow, int endRow, AutoFitterOptions options) 
          
            Autofits row height in a range.
            




void calculateFormula(boolean recursive, boolean ignoreError, ICustomFunction customFunction) 
          
            Calculates all formulas in this worksheet.
            




void calculateFormula(CalculationOptions options, boolean recursive) 
          
            Calculates all formulas in this worksheet.
            




java.lang.Object calculateFormula(java.lang.String formula) 
          
            Calculates a formula.
            




java.lang.Object calculateFormula(java.lang.String formula, CalculationOptions opts) 
          
            Calculates a formula.
            




void clearComments() 
          
            Clears all comments in designer spreadsheet.
            




void closeAccessCache(int opts) 
          
            Closes the session that uses caches to access the data in this worksheet.
            




void copy(Worksheet sourceSheet) 
          
            Copies contents and formats from another worksheet.
            




void copy(Worksheet sourceSheet, CopyOptions copyOptions) 
          
            Copies contents and formats from another worksheet.
            




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




void freezePanes(int row, int column, int freezedRows, int freezedColumns) 
          
            Freezes panes at the specified cell in the worksheet.
            




void freezePanes(java.lang.String cellName, int freezedRows, int freezedColumns) 
          
            Freezes panes at the specified cell in the worksheet.
            




int[] getFreezedPanes() 
          
            Gets the freeze panes.
            




PaneCollection getPanes() 
          
            Gets the window panes.
            




com.aspose.cells.CellArea[] getPrintingPageBreaks(ImageOrPrintOptions options) 
          
            Gets automatic page breaks.
            




java.util.ArrayList getSelectedRanges() 
          
            Gets selected ranges of cells in the designer spreadsheet.
            




void moveTo(int index) 
          
            Moves the sheet to another location in the spreadsheet.
            




void protect(int type) 
          
             Protects worksheet.
             




void protect(int type, java.lang.String password, java.lang.String oldPassword) 
          
            Protects worksheet.
            




void refreshPivotTables() 
          
            Refreshes all the PivotTables in this Worksheet.
            




void removeAllDrawingObjects() 
          
            Removes all drawing objects in this worksheet.
            




void removeAutoFilter() 
          
            Removes the auto filter of the worksheet.
            




void removeSplit() 
          
            Removes split window.
            




int replace(java.lang.String oldString, java.lang.String newString) 
          
            Replaces all cells' text with a new string.
            




void selectRange(int startRow, int startColumn, int totalRows, int totalColumns, boolean removeOthers) 
          
            Selects a range.
            




void setBackground(byte[] pictureData) 
          
            Sets worksheet background image.
            




void setVisible(boolean isVisible, boolean ignoreError) 
          
            Sets the visible options.
            




void split() 
          
            Splits window.
            




void startAccessCache(int opts) 
          
            Starts the session that uses caches to access the data in this worksheet.
            




java.lang.String toString() 
          
            Returns a string represents the current Worksheet object.
            




void unFreezePanes() 
          
            Unfreezes panes in the worksheet.
            




void unprotect() 
          
            Unprotects worksheet.
            




void unprotect(java.lang.String password) 
          
            Unprotects worksheet.
            




java.util.ArrayList xmlMapQuery(java.lang.String path, XmlMap xmlMap) 
          
             Query cell areas that mapped/linked to the specific path of xml map.
             

 








Property Getters/Setters Detail



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.
            



getUniqueId/setUniqueId 
public java.lang.String getUniqueId() / public void setUniqueId(java.lang.String value)


            Gets and sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}.
            



setUniqueId 
public void setUniqueId(java.lang.String value)


            Gets and sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}.
            




getWorkbook 
public Workbook getWorkbook()


            Gets the workbook object which contains this sheet.
            



getCells 
public Cells getCells()


            Gets the Cells collection.
            



getQueryTables 
public QueryTableCollection getQueryTables()


            Gets QueryTableCollection in the worksheet.
            



getPivotTables 
public PivotTableCollection getPivotTables()


            Gets all pivot tables in this worksheet.
            



getType/setType 
public int getType() / public void setType(int value)


            Represents worksheet type.
            The value of the property is SheetType integer constant.



setType 
public void setType(int value)


            Represents worksheet type.
            The value of the property is SheetType integer constant.




getName/setName 
public java.lang.String getName() / public void setName(java.lang.String 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.



setName 
public void setName(java.lang.String 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 
public boolean getShowFormulas() / public void setShowFormulas(boolean value)


            Indicates whether to show formulas or their results.
            



setShowFormulas 
public void setShowFormulas(boolean value)


            Indicates whether to show formulas or their results.
            




isGridlinesVisible/setGridlinesVisible 
public boolean isGridlinesVisible() / public void setGridlinesVisible(boolean value)


            Gets or sets a value indicating whether the gridlines are visible.Default is true.
            



setGridlinesVisible 
public void setGridlinesVisible(boolean value)


            Gets or sets a value indicating whether the gridlines are visible.Default is true.
            




isRowColumnHeadersVisible/setRowColumnHeadersVisible 
public boolean isRowColumnHeadersVisible() / public void setRowColumnHeadersVisible(boolean value)


            Gets or sets a value indicating whether the worksheet will display row and column headers.
            Default is true.
            



setRowColumnHeadersVisible 
public void setRowColumnHeadersVisible(boolean value)


            Gets or sets a value indicating whether the worksheet will display row and column headers.
            Default is true.
            




getPaneState 
public 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 
public boolean getDisplayZeros() / public void setDisplayZeros(boolean value)


            True if zero values are displayed. 
            



setDisplayZeros 
public void setDisplayZeros(boolean value)


            True if zero values are displayed. 
            




getDisplayRightToLeft/setDisplayRightToLeft 
public boolean getDisplayRightToLeft() / 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.
            



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




isOutlineShown/setOutlineShown 
public boolean isOutlineShown() / public void setOutlineShown(boolean value)


            Indicates whether to show outline.
            



setOutlineShown 
public void setOutlineShown(boolean value)


            Indicates whether to show outline.
            




isSelected/setSelected 
public boolean isSelected() / public void setSelected(boolean value)


            Indicates whether this worksheet is selected when the workbook is opened.
            



setSelected 
public void setSelected(boolean value)


            Indicates whether this worksheet is selected when the workbook is opened.
            




getListObjects 
public ListObjectCollection getListObjects()


            Gets all ListObjects in this worksheet.
            



getTabId/setTabId 
public int getTabId() / public void setTabId(int value)


            Specifies the internal identifier for the sheet.
            



setTabId 
public void setTabId(int value)


            Specifies the internal identifier for the sheet.
            




getHorizontalPageBreaks 
public HorizontalPageBreakCollection getHorizontalPageBreaks()


            Gets the HorizontalPageBreakCollection collection. 
            



getVerticalPageBreaks 
public VerticalPageBreakCollection getVerticalPageBreaks()


            Gets the VerticalPageBreakCollection collection.
            



getHyperlinks 
public HyperlinkCollection getHyperlinks()


            Gets the HyperlinkCollection collection.
            



getPageSetup 
public PageSetup getPageSetup()


            Represents the page setup description in this sheet.
            



getAutoFilter 
public AutoFilter getAutoFilter()


            Represents auto filter for the specified worksheet.
            



hasAutofilter 
public boolean hasAutofilter()


            Indicates whether this worksheet has auto filter.
            



getTransitionEvaluation/setTransitionEvaluation 
public boolean getTransitionEvaluation() / public void setTransitionEvaluation(boolean value)


            Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.
            



setTransitionEvaluation 
public void setTransitionEvaluation(boolean value)


            Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.
            




getTransitionEntry/setTransitionEntry 
public boolean getTransitionEntry() / public void setTransitionEntry(boolean value)


            Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.
            



setTransitionEntry 
public void setTransitionEntry(boolean value)


            Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.
            




getVisibilityType/setVisibilityType 
public int getVisibilityType() / public void setVisibilityType(int value)


            Indicates the visible state for this sheet.
            The value of the property is VisibilityType integer constant.



setVisibilityType 
public void setVisibilityType(int value)


            Indicates the visible state for this sheet.
            The value of the property is VisibilityType integer constant.




isVisible/setVisible 
public boolean isVisible() / public void setVisible(boolean value)


            Represents if the worksheet is visible.
            



setVisible 
public void setVisible(boolean value)


            Represents if the worksheet is visible.
            




getSparklineGroupCollection 
public SparklineGroupCollection getSparklineGroupCollection()


            Gets the sparkline group collection in the worksheet.
            



getCharts 
public ChartCollection getCharts()


            Gets a Chart collection
            



getComments 
public CommentCollection getComments()


            Gets the Comment collection.
            



getPictures 
public PictureCollection getPictures()


            Gets a Picture collection.
            



getTextBoxes 
public TextBoxCollection getTextBoxes()


            Gets a TextBox collection.
            



getCheckBoxes 
public CheckBoxCollection getCheckBoxes()


            Gets a CheckBox collection.
            



getOleObjects 
public OleObjectCollection getOleObjects()


            Represents a collection of OleObject in a worksheet.
            



getShapes 
public ShapeCollection getShapes()


            Returns all drawing shapes in this worksheet.
            



getSlicers 
public SlicerCollection getSlicers()


            Get the Slicer collection in the worksheet
            



getTimelines 
public TimelineCollection getTimelines()


            Get the Timeline collection in the worksheet
            



getIndex 
public int getIndex()


            Gets the index of sheet in the worksheet collection.
            



isProtected 
public boolean isProtected()


            Indicates if the worksheet is protected.
            



getValidations 
public ValidationCollection getValidations()


            Gets the data validation setting collection in the worksheet.
            



getAllowEditRanges 
public ProtectedRangeCollection getAllowEditRanges()


            Gets the allow edit range collection in the worksheet.
            



getErrorCheckOptions 
public ErrorCheckOptionCollection getErrorCheckOptions()


            Gets error check setting applied on certain ranges.
            



getOutline 
public Outline getOutline()


            Gets the outline on this worksheet.
            



getFirstVisibleRow/setFirstVisibleRow 
public int getFirstVisibleRow() / public void setFirstVisibleRow(int value)


            Represents first visible row index.
            



setFirstVisibleRow 
public void setFirstVisibleRow(int value)


            Represents first visible row index.
            




getFirstVisibleColumn/setFirstVisibleColumn 
public int getFirstVisibleColumn() / public void setFirstVisibleColumn(int value)


            Represents first visible column index.
            



setFirstVisibleColumn 
public void setFirstVisibleColumn(int value)


            Represents first visible column index.
            




getZoom/setZoom 
public int getZoom() / public void setZoom(int value)


            Represents the scaling factor in percentage. It should be between 10 and 400.
            
Please set the view type first.



setZoom 
public void setZoom(int value)


            Represents the scaling factor in percentage. It should be between 10 and 400.
            
Please set the view type first.




getViewType/setViewType 
public int getViewType() / public void setViewType(int value)


            Gets and sets the view type.
            The value of the property is ViewType integer constant.



setViewType 
public void setViewType(int value)


            Gets and sets the view type.
            The value of the property is ViewType integer constant.




isPageBreakPreview/setPageBreakPreview 
public boolean isPageBreakPreview() / public void setPageBreakPreview(boolean value)


            Indicates whether the specified worksheet is shown in normal view or page break preview.
            



setPageBreakPreview 
public void setPageBreakPreview(boolean value)


            Indicates whether the specified worksheet is shown in normal view or page break preview.
            




isRulerVisible/setRulerVisible 
public boolean isRulerVisible() / public void setRulerVisible(boolean value)


            Indicates whether the ruler is visible. This property is only applied for page break preview.
            



setRulerVisible 
public void setRulerVisible(boolean value)


            Indicates whether the ruler is visible. This property is only applied for page break preview.
            




getTabColor/setTabColor 
public com.aspose.cells.Color getTabColor() / public void setTabColor(com.aspose.cells.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.



setTabColor 
public void setTabColor(com.aspose.cells.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.




getCodeName/setCodeName 
public java.lang.String getCodeName() / public void setCodeName(java.lang.String value)


            Gets worksheet code name.
            



setCodeName 
public void setCodeName(java.lang.String value)


            Gets worksheet code name.
            




getBackgroundImage/setBackgroundImage 
public byte[] getBackgroundImage() / public void setBackgroundImage(byte[] value)


            Gets and sets worksheet background image.
            



setBackgroundImage 
public void setBackgroundImage(byte[] value)


            Gets and sets worksheet background image.
            




getConditionalFormattings 
public ConditionalFormattingCollection getConditionalFormattings()


            Gets the ConditionalFormattings in the worksheet.
            



getActiveCell/setActiveCell 
public java.lang.String getActiveCell() / public void setActiveCell(java.lang.String value)


            Gets or sets the active cell in the worksheet. 
            



setActiveCell 
public void setActiveCell(java.lang.String value)


            Gets or sets the active cell in the worksheet. 
            




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. 
            



getSmartTagSetting 
public SmartTagSetting getSmartTagSetting()


            Gets all SmartTagCollection objects of the worksheet.
            



getScenarios 
public ScenarioCollection getScenarios()


            Gets the collection of Scenario.
            



getCellWatches 
public CellWatchCollection getCellWatches()


            Gets collection of cells on this worksheet being watched in the 'watch window'.
            







Method Detail



replace 
public int replace(java.lang.String oldString, java.lang.String newString)

            Replaces all cells' text with a new string.
            
Parameters:
oldString - Old string value.
newString - New string value.




getSelectedRanges 
public java.util.ArrayList getSelectedRanges()

            Gets selected ranges of cells in the designer spreadsheet.
            
Returns:
An java.util.ArrayList which contains selected ranges.




setBackground 
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:
pictureData - Picture data.




getPrintingPageBreaks 
public com.aspose.cells.CellArea[] getPrintingPageBreaks(ImageOrPrintOptions options)
                                throws java.lang.Exception

            Gets automatic page breaks.
            

            Each cell area represents a paper.
            Parameters:
options - The print options
Returns:
The automatic page breaks areas.




toString 
public java.lang.String toString()

            Returns a string represents the current Worksheet object.
            
Returns:





startAccessCache 
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, closeAccessCache(int) should
            be invoked with same options to clear all caches and recover normal access mode.
            Parameters:
opts - A AccessCacheOptions value. options of data access




closeAccessCache 
public void closeAccessCache(int opts)

            Closes the session that uses caches to access the data in this worksheet.
            
Parameters:
opts - A AccessCacheOptions value. options of data access




calculateFormula 
public java.lang.Object calculateFormula(java.lang.String formula)

            Calculates a formula.
            
Parameters:
formula - Formula to be calculated.
Returns:
Calculated formula result.




calculateFormula 
public java.lang.Object calculateFormula(java.lang.String formula, CalculationOptions opts)

            Calculates a formula.
            
Parameters:
formula - Formula to be calculated.
opts - Options for calculating formula
Returns:
Calculated formula result.




calculateFormula 
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:
recursive - 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 - Indicates if hide the error in calculating formulas.
            The error may be unsupported function, external links, etc.
customFunction - The custom formula calculation functions to extend the calculation engine.




calculateFormula 
public void calculateFormula(CalculationOptions options, boolean recursive)

            Calculates all formulas in this worksheet.
            
Parameters:
options - Options for calculation
recursive - 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 
public java.util.ArrayList xmlMapQuery(java.lang.String path, XmlMap xmlMap)
                     throws java.lang.Exception

             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 - xml element path
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 
public void refreshPivotTables()
                       throws java.lang.Exception

            Refreshes all the PivotTables in this Worksheet.
            




dispose 
public void dispose()

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




getPanes 
public PaneCollection getPanes()

            Gets the window panes.
            

            If the window is not split or frozen.
            




freezePanes 
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:
row - Row index.
column - Column index.
freezedRows - Number of visible rows in top pane, no more than row index.
freezedColumns - Number of visible columns in left pane, no more than column index.




getFreezedPanes 
public 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 
public void split()

            Splits window.
            




freezePanes 
public void freezePanes(java.lang.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:
cellName - Cell name.
freezedRows - Number of visible rows in top pane, no more than row index.
freezedColumns - Number of visible columns in left pane, no more than column index.




unFreezePanes 
public void unFreezePanes()

            Unfreezes panes in the worksheet.
            




removeSplit 
public void removeSplit()

            Removes split window.
            




addPageBreaks 
public void addPageBreaks(java.lang.String cellName)

            Adds page break.
            
Parameters:
cellName - 




copy 
public void copy(Worksheet sourceSheet)
         throws java.lang.Exception

            Copies contents and formats from another worksheet.
            
Parameters:
sourceSheet - Source worksheet.




copy 
public void copy(Worksheet sourceSheet, CopyOptions copyOptions)
         throws java.lang.Exception

            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 - Source worksheet.
copyOptions - 




autoFitColumn 
public void autoFitColumn(int columnIndex, int firstRow, int lastRow)
                  throws java.lang.Exception

            Autofits the column width.
            
This method autofits a row based on content in a range of cells within the row.
            Parameters:
columnIndex - Column index.
firstRow - First row index.
lastRow - Last row index.




autoFitColumns 
public void autoFitColumns()
                   throws java.lang.Exception

            Autofits all columns in this worksheet.
            




autoFitColumns 
public void autoFitColumns(AutoFitterOptions options)
                   throws java.lang.Exception

            Autofits all columns in this worksheet.
            
Parameters:
options - The auto fitting options
            




autoFitColumn 
public void autoFitColumn(int columnIndex)
                  throws java.lang.Exception

            Autofits the column width.
            
AutoFitColumn is an imprecise function.Parameters:
columnIndex - Column index.




autoFitColumns 
public void autoFitColumns(int firstColumn, int lastColumn)
                   throws java.lang.Exception

            Autofits the columns width.
            
AutoFitColumn is an imprecise function.Parameters:
firstColumn - First column index.
lastColumn - Last column index.




autoFitColumns 
public void autoFitColumns(int firstColumn, int lastColumn, AutoFitterOptions options)
                   throws java.lang.Exception

            Autofits the columns width.
            
AutoFitColumn is an imprecise function.Parameters:
firstColumn - First column index.
lastColumn - Last column index.
options - The auto fitting options




autoFitColumns 
public void autoFitColumns(int firstRow, int firstColumn, int lastRow, int lastColumn)
                   throws java.lang.Exception

            Autofits the columns width.
            
AutoFitColumn is an imprecise function.Parameters:
firstRow - First row index.
firstColumn - First column index.
lastRow - Last row index.
lastColumn - Last column index.




autoFitColumns 
public void autoFitColumns(int firstRow, int firstColumn, int lastRow, int lastColumn, AutoFitterOptions options)
                   throws java.lang.Exception

            Autofits the columns width.
            
AutoFitColumn is an imprecise function.Parameters:
firstRow - First row index.
firstColumn - First column index.
lastRow - Last row index.
lastColumn - Last column index.
options - The auto fitting options




autoFitRow 
public void autoFitRow(int rowIndex, int firstColumn, int lastColumn)
               throws java.lang.Exception

            Autofits the row height.
            
This method autofits a row based on content in a range of cells within the row.
            Parameters:
rowIndex - Row index.
firstColumn - First column index.
lastColumn - Last column index.




autoFitRow 
public void autoFitRow(int rowIndex, int firstColumn, int lastColumn, AutoFitterOptions options)
               throws java.lang.Exception

            Autofits the row height.
            
This method autofits a row based on content in a range of cells within the row.
            Parameters:
rowIndex - Row index.
firstColumn - First column index.
lastColumn - Last column index.
options - The auto fitter options




autoFitRows 
public void autoFitRows()
                throws java.lang.Exception

            Autofits all rows in this worksheet.
            




autoFitRows 
public void autoFitRows(boolean onlyAuto)
                throws java.lang.Exception

            Autofits all rows in this worksheet.
            
Parameters:
onlyAuto - 
            True,only autofits the row height when row height is not customed.
            




autoFitRows 
public void autoFitRows(AutoFitterOptions options)
                throws java.lang.Exception

            Autofits all rows in this worksheet.
            
Parameters:
options - The auto fitter options




autoFitRows 
public void autoFitRows(int startRow, int endRow)
                throws java.lang.Exception

            Autofits row height in a range.
            
Parameters:
startRow - Start row index.
endRow - End row index.




autoFitRows 
public void autoFitRows(int startRow, int endRow, AutoFitterOptions options)
                throws java.lang.Exception

            Autofits row height in a range.
            
Parameters:
startRow - Start row index.
endRow - End row index.
options - The options of auto fitter.




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

            Autofits row height in a rectangle range.
            
Parameters:
startRow - Start row index.
endRow - End row index.
startColumn - Start column index.
endColumn - End column index.




autoFitRow 
public void autoFitRow(int rowIndex)
               throws java.lang.Exception

            Autofits the row height.
            
AutoFitRow is an imprecise function.Parameters:
rowIndex - Row index.




advancedFilter 
public void advancedFilter(boolean isFilter, java.lang.String listRange, java.lang.String criteriaRange, java.lang.String copyTo, boolean uniqueRecordOnly)

            Filters data using complex criteria.
             
Parameters:
isFilter - Indicates whether filtering the list in place.
listRange - The list range.
criteriaRange - The criteria range.
copyTo - The range where copying data to. 
uniqueRecordOnly - Only displaying or copying unique rows.




removeAutoFilter 
public void removeAutoFilter()

            Removes the auto filter of the worksheet.
            




setVisible 
public void setVisible(boolean isVisible, boolean ignoreError)

            Sets the visible options.
            
Parameters:
isVisible - Whether the worksheet is visible
ignoreError - Whether to ignore error if this option is not valid.




selectRange 
public void selectRange(int startRow, int startColumn, int totalRows, int totalColumns, boolean removeOthers)

            Selects a range.
            
Parameters:
startRow - The start row.
            
startColumn - The start column
totalRows - The number of rows.
totalColumns - The number of columns
removeOthers - True means removing other selected range and only select this range.
            




removeAllDrawingObjects 
public void removeAllDrawingObjects()

            Removes all drawing objects in this worksheet.
            




clearComments 
public void clearComments()

            Clears all comments in designer spreadsheet.
            




protect 
public void protect(int type)

             Protects worksheet.
             
This method protects worksheet without password. It can protect worksheet in all versions of Excel file. 
            Parameters:
type - A ProtectionType value. Protection type.




protect 
public void protect(int type, java.lang.String password, java.lang.String oldPassword)

            Protects worksheet.
            
This method can protect worksheet in all versions of Excel file. 
            Parameters:
type - A ProtectionType value. Protection type.
password - Password.
oldPassword - 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
Workbook excel = new Workbook("C:\\book1.xls");
//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("C:\\output.xls");




unprotect 
public void unprotect()

            Unprotects worksheet.
            
 This method unprotects worksheet which is protected without password.
            




unprotect 
public void unprotect(java.lang.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:
password - Password




moveTo 
public void moveTo(int index)

            Moves the sheet to another location in the spreadsheet.
            
Parameters:
index - Destination sheet index.




See Also:


          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.

          Aspose.Cells Support Forum - our preferred method of support.
We guarantee a prompt response to any inquiry!
© 2003-2022 Aspose Pty Ltd. All rights reserved.

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

Method Summary
`void`	`addPageBreaks(java.lang.String cellName)`
`void`	Adds page break.
`void`	`advancedFilter(boolean isFilter, java.lang.String listRange, java.lang.String criteriaRange, java.lang.String copyTo, boolean uniqueRecordOnly)`
`void`	Filters data using complex criteria.
`void`	`autoFitColumn(int columnIndex)`
`void`	Autofits the column width.
`void`	`autoFitColumn(int columnIndex, int firstRow, int lastRow)`
`void`	Autofits the column width.
`void`	`autoFitColumns()`
`void`	Autofits all columns in this worksheet.
`void`	`autoFitColumns(AutoFitterOptions options)`
`void`	Autofits all columns in this worksheet.
`void`	`autoFitColumns(int firstColumn, int lastColumn)`
`void`	Autofits the columns width.
`void`	`autoFitColumns(int firstColumn, int lastColumn, AutoFitterOptions options)`
`void`	Autofits the columns width.
`void`	`autoFitColumns(int firstRow, int firstColumn, int lastRow, int lastColumn)`
`void`	Autofits the columns width.
`void`	`autoFitColumns(int firstRow, int firstColumn, int lastRow, int lastColumn, AutoFitterOptions options)`
`void`	Autofits the columns width.
`void`	`autoFitRow(int rowIndex)`
`void`	Autofits the row height.
`void`	`autoFitRow(int rowIndex, int firstColumn, int lastColumn)`
`void`	Autofits the row height.
`void`	`autoFitRow(int rowIndex, int firstColumn, int lastColumn, AutoFitterOptions options)`
`void`	Autofits the row height.
`void`	`autoFitRow(int startRow, int endRow, int startColumn, int endColumn)`
`void`	Autofits row height in a rectangle range.
`void`	`autoFitRows()`
`void`	Autofits all rows in this worksheet.
`void`	`autoFitRows(boolean onlyAuto)`
`void`	Autofits all rows in this worksheet.
`void`	`autoFitRows(AutoFitterOptions options)`
`void`	Autofits all rows in this worksheet.
`void`	`autoFitRows(int startRow, int endRow)`
`void`	Autofits row height in a range.
`void`	`autoFitRows(int startRow, int endRow, AutoFitterOptions options)`
`void`	Autofits row height in a range.
`void`	`calculateFormula(boolean recursive, boolean ignoreError, ICustomFunction customFunction)`
`void`	Calculates all formulas in this worksheet.
`void`	`calculateFormula(CalculationOptions options, boolean recursive)`
`void`	Calculates all formulas in this worksheet.
`java.lang.Object`	`calculateFormula(java.lang.String formula)`
`java.lang.Object`	Calculates a formula.
`java.lang.Object`	`calculateFormula(java.lang.String formula, CalculationOptions opts)`
`java.lang.Object`	Calculates a formula.
`void`	`clearComments()`
`void`	Clears all comments in designer spreadsheet.
`void`	`closeAccessCache(int opts)`
`void`	Closes the session that uses caches to access the data in this worksheet.
`void`	`copy(Worksheet sourceSheet)`
`void`	Copies contents and formats from another worksheet.
`void`	`copy(Worksheet sourceSheet, CopyOptions copyOptions)`
`void`	Copies contents and formats from another worksheet.
`void`	`dispose()`
`void`	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
`void`	`freezePanes(int row, int column, int freezedRows, int freezedColumns)`
`void`	Freezes panes at the specified cell in the worksheet.
`void`	`freezePanes(java.lang.String cellName, int freezedRows, int freezedColumns)`
`void`	Freezes panes at the specified cell in the worksheet.
`int[]`	`getFreezedPanes()`
`int[]`	Gets the freeze panes.
`PaneCollection`	`getPanes()`
`PaneCollection`	Gets the window panes.
`com.aspose.cells.CellArea[]`	`getPrintingPageBreaks(ImageOrPrintOptions options)`
`com.aspose.cells.CellArea[]`	Gets automatic page breaks.
`java.util.ArrayList`	`getSelectedRanges()`
`java.util.ArrayList`	Gets selected ranges of cells in the designer spreadsheet.
`void`	`moveTo(int index)`
`void`	Moves the sheet to another location in the spreadsheet.
`void`	`protect(int type)`
`void`	Protects worksheet.
`void`	`protect(int type, java.lang.String password, java.lang.String oldPassword)`
`void`	Protects worksheet.
`void`	`refreshPivotTables()`
`void`	Refreshes all the PivotTables in this Worksheet.
`void`	`removeAllDrawingObjects()`
`void`	Removes all drawing objects in this worksheet.
`void`	`removeAutoFilter()`
`void`	Removes the auto filter of the worksheet.
`void`	`removeSplit()`
`void`	Removes split window.
`int`	`replace(java.lang.String oldString, java.lang.String newString)`
`int`	Replaces all cells' text with a new string.
`void`	`selectRange(int startRow, int startColumn, int totalRows, int totalColumns, boolean removeOthers)`
`void`	Selects a range.
`void`	`setBackground(byte[] pictureData)`
`void`	Sets worksheet background image.
`void`	`setVisible(boolean isVisible, boolean ignoreError)`
`void`	Sets the visible options.
`void`	`split()`
`void`	Splits window.
`void`	`startAccessCache(int opts)`
`void`	Starts the session that uses caches to access the data in this worksheet.
`java.lang.String`	`toString()`
`java.lang.String`	Returns a string represents the current Worksheet object.
`void`	`unFreezePanes()`
`void`	Unfreezes panes in the worksheet.
`void`	`unprotect()`
`void`	Unprotects worksheet.
`void`	`unprotect(java.lang.String password)`
`void`	Unprotects worksheet.
`java.util.ArrayList`	`xmlMapQuery(java.lang.String path, XmlMap xmlMap)`
`java.util.ArrayList`	Query cell areas that mapped/linked to the specific path of xml map.

getUniqueId/setUniqueId
public java.lang.String getUniqueId() / public void setUniqueId(java.lang.String value)

setUniqueId
public void setUniqueId(java.lang.String value)

getQueryTables
public QueryTableCollection getQueryTables()

getPivotTables
public PivotTableCollection getPivotTables()

getType/setType
public int getType() / public void setType(int value)

getName/setName
public java.lang.String getName() / public void setName(java.lang.String value)

getShowFormulas/setShowFormulas
public boolean getShowFormulas() / public void setShowFormulas(boolean value)

setShowFormulas
public void setShowFormulas(boolean value)

isGridlinesVisible/setGridlinesVisible
public boolean isGridlinesVisible() / public void setGridlinesVisible(boolean value)

setGridlinesVisible
public void setGridlinesVisible(boolean value)

isRowColumnHeadersVisible/setRowColumnHeadersVisible
public boolean isRowColumnHeadersVisible() / public void setRowColumnHeadersVisible(boolean value)

setRowColumnHeadersVisible
public void setRowColumnHeadersVisible(boolean value)

getDisplayZeros/setDisplayZeros
public boolean getDisplayZeros() / public void setDisplayZeros(boolean value)

setDisplayZeros
public void setDisplayZeros(boolean value)

getDisplayRightToLeft/setDisplayRightToLeft
public boolean getDisplayRightToLeft() / public void setDisplayRightToLeft(boolean value)

setDisplayRightToLeft
public void setDisplayRightToLeft(boolean value)

isOutlineShown/setOutlineShown
public boolean isOutlineShown() / public void setOutlineShown(boolean value)

setOutlineShown
public void setOutlineShown(boolean value)

isSelected/setSelected
public boolean isSelected() / public void setSelected(boolean value)

getListObjects
public ListObjectCollection getListObjects()

com.aspose.cells.Worksheet.html Maven / Gradle / Ivy

com.aspose.cells Class Worksheet

getProtection

getUniqueId/setUniqueId

setUniqueId

getWorkbook

getCells

getQueryTables

getPivotTables

getType/setType

setType

getName/setName

setName

getShowFormulas/setShowFormulas

setShowFormulas

isGridlinesVisible/setGridlinesVisible

setGridlinesVisible

isRowColumnHeadersVisible/setRowColumnHeadersVisible

setRowColumnHeadersVisible

getPaneState

getDisplayZeros/setDisplayZeros

setDisplayZeros

getDisplayRightToLeft/setDisplayRightToLeft

setDisplayRightToLeft

isOutlineShown/setOutlineShown

setOutlineShown

isSelected/setSelected

setSelected

getListObjects

getTabId/setTabId

setTabId

getHorizontalPageBreaks

getVerticalPageBreaks

getHyperlinks

getPageSetup

getAutoFilter

hasAutofilter

getTransitionEvaluation/setTransitionEvaluation

setTransitionEvaluation

getTransitionEntry/setTransitionEntry

setTransitionEntry

getVisibilityType/setVisibilityType

setVisibilityType

isVisible/setVisible

setVisible

getSparklineGroupCollection

getCharts

getComments

getPictures

getTextBoxes

getCheckBoxes

getOleObjects

getShapes

getSlicers

getTimelines

getIndex

isProtected

getValidations

getAllowEditRanges

getErrorCheckOptions

getOutline

getFirstVisibleRow/setFirstVisibleRow

setFirstVisibleRow

getFirstVisibleColumn/setFirstVisibleColumn

setFirstVisibleColumn

getZoom/setZoom

setZoom

getViewType/setViewType

setViewType

isPageBreakPreview/setPageBreakPreview

setPageBreakPreview

isRulerVisible/setRulerVisible

setRulerVisible

getTabColor/setTabColor

setTabColor

getCodeName/setCodeName

setCodeName

getBackgroundImage/setBackgroundImage

setBackgroundImage

getConditionalFormattings

com.aspose.cells
Class Worksheet

getTabId/setTabId
public int getTabId() / public void setTabId(int value)

getHorizontalPageBreaks
public HorizontalPageBreakCollection getHorizontalPageBreaks()

getVerticalPageBreaks
public VerticalPageBreakCollection getVerticalPageBreaks()

getTransitionEvaluation/setTransitionEvaluation
public boolean getTransitionEvaluation() / public void setTransitionEvaluation(boolean value)

setTransitionEvaluation
public void setTransitionEvaluation(boolean value)

getTransitionEntry/setTransitionEntry
public boolean getTransitionEntry() / public void setTransitionEntry(boolean value)

setTransitionEntry
public void setTransitionEntry(boolean value)

getVisibilityType/setVisibilityType
public int getVisibilityType() / public void setVisibilityType(int value)

setVisibilityType
public void setVisibilityType(int value)

isVisible/setVisible
public boolean isVisible() / public void setVisible(boolean value)