Worksheet

Overview

Worksheet is a class in Aspose.Cells FOSS for Java.

Represents a worksheet in a workbook.

This class provides 35 methods for working with Worksheet objects in Java programs. Available methods include: freezePanes, getAutoFilter, getCells, getCharts, getComments, getConditionalFormattings, getFreezedColumns, getFreezedRows, getHyperlinks, getListObjects, getName, getPageSetup, and 23 additional methods. All exported members are accessible to any Java application after installing the Aspose.Cells FOSS for Java package. Properties: autoFilter, cells, charts, comments, conditionalFormattings, freezedColumns, and 17 more.

Properties

Name	Type	Access	Description
`name`	`String`	Read	Returns the name.
`visibilityType`	`VisibilityType`	Read	Returns the visibility type.
`tabColor`	`Color`	Read	Returns the tab color.
`showGridlines`	`boolean`	Read	Returns the show gridlines.
`showRowColumnHeaders`	`boolean`	Read	Returns the show row column headers.
`showZeros`	`boolean`	Read	Returns the show zeros.
`rightToLeft`	`boolean`	Read	Returns the right to left.
`zoom`	`int`	Read	Returns the zoom.
`cells`	`Cells`	Read	Returns the cells.
`protection`	`WorksheetProtection`	Read	Returns the protection.
`pageSetup`	`PageSetup`	Read	Returns the page setup.
`validations`	`ValidationCollection`	Read	Returns the validations.
`hyperlinks`	`HyperlinkCollection`	Read	Returns the hyperlinks.
`autoFilter`	`AutoFilter`	Read	Returns the auto filter.
`conditionalFormattings`	`ConditionalFormattingCollection`	Read	Returns the conditional formattings.
`comments`	`CommentCollection`	Read	Returns the cell comments collection.
`pictures`	`PictureCollection`	Read	Returns the embedded pictures collection.
`shapes`	`ShapeCollection`	Read	Returns the collection of drawing objects (shapes) on this worksheet.
`charts`	`ChartCollection`	Read	Returns the embedded charts collection.
`listObjects`	`ListObjectCollection`	Read	Returns the Excel tables (ListObjects) collection.
`frozen`	`boolean`	Read	Returns whether any panes are currently frozen.
`freezedRows`	`int`	Read	Returns the number of rows frozen from the top.
`freezedColumns`	`int`	Read	Returns the number of columns frozen from the left.

Methods

Signature	Description
`getName()` → `String`	Returns the name.
`setName(name: String)`	Sets the name.
`getVisibilityType()` → `VisibilityType`	Returns the visibility type.
`setVisibilityType(visibilityType: VisibilityType)`	Sets the visibility type.
`getTabColor()` → `Color`	Returns the tab color.
`setTabColor(value: Color)`	Sets the tab color.
`getShowGridlines()` → `boolean`	Returns the show gridlines.
`setShowGridlines(value: boolean)`	Sets the show gridlines.
`getShowRowColumnHeaders()` → `boolean`	Returns the show row column headers.
`setShowRowColumnHeaders(value: boolean)`	Sets the show row column headers.
`getShowZeros()` → `boolean`	Returns the show zeros.
`setShowZeros(value: boolean)`	Sets the show zeros.
`getRightToLeft()` → `boolean`	Returns the right to left.
`setRightToLeft(value: boolean)`	Sets the right to left.
`getZoom()` → `int`	Returns the zoom.
`setZoom(value: int)`	Sets the zoom.
`getCells()` → `Cells`	Returns the cells.
`getProtection()` → `WorksheetProtection`	Returns the protection.
`getPageSetup()` → `PageSetup`	Returns the page setup.
`getValidations()` → `ValidationCollection`	Returns the validations.
`getHyperlinks()` → `HyperlinkCollection`	Returns the hyperlinks.
`getAutoFilter()` → `AutoFilter`	Returns the auto filter.
`getConditionalFormattings()` → `ConditionalFormattingCollection`	Returns the conditional formattings.
`getComments()` → `CommentCollection`	Returns the cell comments collection.
`getPictures()` → `PictureCollection`	Returns the embedded pictures collection.
`getShapes()` → `ShapeCollection`	Returns the collection of drawing objects (shapes) on this worksheet.
`getCharts()` → `ChartCollection`	Returns the embedded charts collection.
`getListObjects()` → `ListObjectCollection`	Returns the Excel tables (ListObjects) collection.
`freezePanes(row: int, column: int, freezedRows: int, freezedCols: int)`	Freezes panes at the specified cell in the worksheet.
`freezePanes(cellName: String, freezedRows: int, freezedCols: int)`	Freezes panes at the specified cell in the worksheet.
`unFreezePanes()`	Unfreezes all frozen panes in the worksheet.
`isFrozen()` → `boolean`	Returns whether any panes are currently frozen.
`getFreezedRows()` → `int`	Returns the number of rows frozen from the top.
`getFreezedColumns()` → `int`	Returns the number of columns frozen from the left.
`protect()`	Enables protection for the current object.
`unprotect()`	Disables protection for the current object.

Worksheet

Overview

Properties

Methods

See Also