com.aspose.cells
Class Worksheet

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

public class Worksheet 
extends java.lang.Object

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");

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.

public Workbook getWorkbook()

Gets the workbook object which contains this sheet.

public CommentCollection getComments()

Gets the CommentCollection collection.

public Cells getCells()

Gets the Cells collection.

public QueryTableCollection getQueryTables()

Gets the queryTables in the worksheet.

public PivotTableCollection getPivotTables()

Gets the pivotTables in the worksheet.

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

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

Excel worksheet type

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.

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

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

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.

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

True if zero values are displayed.

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.

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

Indicates whether show outline.

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

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

public PictureCollection getPictures()

Gets a Pictures collection.

public ListObjectCollection getListObjects()

Gets all ListObjects in this worksheet.

public TextBoxCollection getTextBoxes()

Gets a TextBoxes collection.

public CheckBoxCollection getCheckBoxes()

Gets a CheckBoxes collection.

public OleObjectCollection getOleObjects()

Represents a collection of OleObject in a worksheet.

public ChartCollection getCharts()

Gets a ChartCollection collection

public HorizontalPageBreakCollection getHPageBreaks()

Gets the HorizontalPageBreakCollection collection.

NOTE: This member is now obsolete. Instead, please use Worksheet.HorizontalPageBreaks property. This property will be removed 12 months later since JULY 2010. Aspose apologizes for any inconvenience you may have experienced.

public HorizontalPageBreakCollection getHorizontalPageBreaks()

Gets the HorizontalPageBreakCollection collection.

public VerticalPageBreakCollection getVPageBreaks()

Gets the VerticalPageBreakCollection collection.

NOTE: This member is now obsolete. Instead, please use Worksheet.VerticalPageBreaks property. This property will be removed 12 months later since JULY 2010. Aspose apologizes for any inconvenience you may have experienced.

public VerticalPageBreakCollection getVerticalPageBreaks()

Gets the VerticalPageBreakCollection collection.

public HyperlinkCollection getHyperlinks()

Gets the HyperlinkCollection collection.

public PageSetup getPageSetup()

Represents the page setup description in this sheet.

public AutoFilter getAutoFilter()

Represents autofiltering for the specified worksheet.

public boolean hasAutofilter()

Indicates whether worksheet has auto filter.

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

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

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

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

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

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

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

Represents if the worksheet is visible.

public ShapeCollection getShapes()

Returns all drawing shapes in this worksheet.

public int getIndex()

Gets the index of sheet in the worksheets collection.

public boolean isProtected()

Indicates if the worksheet is protected.

public ValidationCollection getValidations()

Gets the data validation setting collection in the worksheet.

public ProtectedRangeCollection getAllowEditRanges()

Gets the allow edit range collection in the worksheet.

public ErrorCheckOptionCollection getErrorCheckOptions()

Represents error check setting applied on certain ranges.

public Outline getOutline()

Represents an outline on a worksheet.

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

Represents first visible row index.

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

Represents first visible column index.

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

Represents the scaling factor in percent. It should be btween 10 and 400.

Please set the view type first.

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

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

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

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

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

Indicates whether the ruler is visible. Only apply for page break preview.

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 above version. If you save file as Excel97 or Excel2000 format, it will be omitted.

public java.lang.String getCodeName()

Represents worksheet code name.

You cannot change the code name while the template file contains VBA/macro.

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

Gets and sets worksheet background image.

public ConditionalFormattingCollection getConditionalFormattings()

Gets the ConditionalFormattings in the worksheet.

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

Gets or sets the active cell in the worksheet.

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.

public SparklineGroupCollection getSparklineGroupCollection()

Gets the sparkline group collection in the worksheet.

public SmartTagSetting getSmartTagSetting()

Gets all SmartTagCollection objects of the worksheet.

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

Replaces all cell's text with a new string.

Parameters:

oldString - Old string value.

newString - New string value.

public void removeAllDrawingObjects()

Removes all drawing objects in this worksheet.

public java.util.ArrayList getSelectedRanges()

Gets selected ranges of cells in the designer spreadsheet.

Returns:

An java.util.ArrayList which contains selected ranges.

public void clearComments()

Clears all comments in designer spreadsheet.

public void setBackground(byte[] pictureData)

Sets worksheet background image.

Parameters:

pictureData - Picture data.

public java.lang.String toString()

Returns a string represents the current Worksheet object.

Returns:

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

Calculates a formula.

Parameters:

formula -

Returns:

public void calculateFormula(boolean recursive, boolean ignoreError, ICustomFunction customFunction)

Calculates all formulas in this worksheet.

Parameters:

recursive - True means if the worksheet' cells depend on the cells of other worksheets, the dependant 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.

public PaneCollection getPanes()

Gets the window panes.

If the window is not splitted or frozen.

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 freezed position and the last two parameters specify the area freezed 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.

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

public void split()

Splits window.

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.

public void unFreezePanes()

Unfreezes panes in the worksheet.

public void removeSplit()

Removes splitted window.

public void addPageBreaks(java.lang.String cellName)

Adds page break.

Parameters:

cellName -

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

Copies contents and formats from another worksheet.

Parameters:

sourceSheet - Source worksheet.

public void copy(Worksheet sourceSheet, CopyOptions copyOption)
         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.

copyOption -

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.

public void autoFitColumns()
                   throws java.lang.Exception

Autofits all columns in this worksheet.

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

Autofits all columns in this worksheet.

Parameters:

options - The auto fitting options

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

Autofits the column width.

AutoFitColumn is an imprecise function.

Parameters:

columnIndex - Column index.

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.

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

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.

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

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.

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

public void autoFitRows()
                throws java.lang.Exception

Autofits all rows in this worksheet.

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.

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

Autofits all rows in this worksheet.

Parameters:

options - The auto fitter options

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.

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.

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

Autofits the row height.

AutoFitRow is an imprecise function.

Parameters:

rowIndex - Row index.

public void removeAutoFilter()

Remove the auto filter of the worksheet.

public void setVisible(boolean isVisible, boolean ignoreError)

Sets the visible options.

Parameters:

isVisible - Whether the worksheet is visible

ignoreError - Whether ignore error if this option is not valid.

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.

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");

public void unprotect()

Unprotects worksheet.

This method unprotects worksheet which is protected without password.

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

public void copyConditionalFormatting(int sourceRow, int sourceColumn, int destRow, int destColumn)

Copies conditional formatting on a cell to another cell.

This method can only copy conditional formatting within the same worksheet.

Parameters:

sourceRow - Source cell row index.

sourceColumn - Source cell column index.

destRow - Destination cell row index.

destColumn - Destination cell column index.

public void move(int index)

Moves the sheet to another location in the spreadsheet.

NOTE: This member is now obsolete. Instead, please use Worsheet.MoveTo(int) method. This property will be removed 12 months later since August 2012. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

index - Destination sheet index.

public void moveTo(int index)

Moves the sheet to another location in the spreadsheet.

Parameters:

index - Destination sheet index.