WorksheetProtection

Overview

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

Represents protection settings for a worksheet.

This class provides 31 methods for working with WorksheetProtection objects in Java programs. Available methods include: getAllowDeletingColumn, getAllowDeletingRow, getAllowEditingObject, getAllowEditingScenario, getAllowFiltering, getAllowFormattingCell, getAllowFormattingColumn, getAllowFormattingRow, getAllowInsertingColumn, getAllowInsertingHyperlink, getAllowInsertingRow, getAllowSelectingLockedCell, and 19 additional methods. All exported members are accessible to any Java application after installing the Aspose.Cells FOSS for Java package. Properties: allowDeletingColumn, allowDeletingRow, allowEditingObject, allowEditingScenario, allowFiltering, allowFormattingCell, and 10 more.

Properties

Name	Type	Access	Description
`protected`	`boolean`	Read	Returns {@code true} if the worksheet is protected.
`allowEditingObject`	`boolean`	Read	Returns {@code true} if editing objects (shapes, charts) is allowed.
`allowEditingScenario`	`boolean`	Read	Returns {@code true} if editing scenarios is allowed.
`allowFormattingCell`	`boolean`	Read	Returns {@code true} if formatting cells is allowed.
`allowFormattingColumn`	`boolean`	Read	Returns {@code true} if formatting columns is allowed.
`allowFormattingRow`	`boolean`	Read	Returns {@code true} if formatting rows is allowed.
`allowInsertingColumn`	`boolean`	Read	Returns {@code true} if inserting columns is allowed.
`allowInsertingRow`	`boolean`	Read	Returns {@code true} if inserting rows is allowed.
`allowInsertingHyperlink`	`boolean`	Read	Returns {@code true} if inserting hyperlinks is allowed.
`allowDeletingColumn`	`boolean`	Read	Returns {@code true} if deleting columns is allowed.
`allowDeletingRow`	`boolean`	Read	Returns {@code true} if deleting rows is allowed.
`allowSelectingLockedCell`	`boolean`	Read	Returns {@code true} if selecting locked cells is allowed.
`allowSorting`	`boolean`	Read	Returns {@code true} if sorting is allowed.
`allowFiltering`	`boolean`	Read	Returns {@code true} if using AutoFilter is allowed.
`allowUsingPivotTable`	`boolean`	Read	Returns {@code true} if using pivot tables is allowed.
`allowSelectingUnlockedCell`	`boolean`	Read	Returns {@code true} if selecting unlocked cells is allowed.

Methods

Signature	Description
`isProtected()` → `boolean`	Returns {@code true} if the worksheet is protected.
`getAllowEditingObject()` → `boolean`	Returns {@code true} if editing objects (shapes, charts) is allowed.
`setAllowEditingObject(allow: boolean)`	Sets whether editing objects is allowed.
`getAllowEditingScenario()` → `boolean`	Returns {@code true} if editing scenarios is allowed.
`setAllowEditingScenario(allow: boolean)`	Sets whether editing scenarios is allowed.
`getAllowFormattingCell()` → `boolean`	Returns {@code true} if formatting cells is allowed.
`setAllowFormattingCell(allow: boolean)`	Sets whether formatting cells is allowed.
`getAllowFormattingColumn()` → `boolean`	Returns {@code true} if formatting columns is allowed.
`setAllowFormattingColumn(allow: boolean)`	Sets whether formatting columns is allowed.
`getAllowFormattingRow()` → `boolean`	Returns {@code true} if formatting rows is allowed.
`setAllowFormattingRow(allow: boolean)`	Sets whether formatting rows is allowed.
`getAllowInsertingColumn()` → `boolean`	Returns {@code true} if inserting columns is allowed.
`setAllowInsertingColumn(allow: boolean)`	Sets whether inserting columns is allowed.
`getAllowInsertingRow()` → `boolean`	Returns {@code true} if inserting rows is allowed.
`setAllowInsertingRow(allow: boolean)`	Sets whether inserting rows is allowed.
`getAllowInsertingHyperlink()` → `boolean`	Returns {@code true} if inserting hyperlinks is allowed.
`setAllowInsertingHyperlink(allow: boolean)`	Sets whether inserting hyperlinks is allowed.
`getAllowDeletingColumn()` → `boolean`	Returns {@code true} if deleting columns is allowed.
`setAllowDeletingColumn(allow: boolean)`	Sets whether deleting columns is allowed.
`getAllowDeletingRow()` → `boolean`	Returns {@code true} if deleting rows is allowed.
`setAllowDeletingRow(allow: boolean)`	Sets whether deleting rows is allowed.
`getAllowSelectingLockedCell()` → `boolean`	Returns {@code true} if selecting locked cells is allowed.
`setAllowSelectingLockedCell(allow: boolean)`	Sets whether selecting locked cells is allowed.
`getAllowSorting()` → `boolean`	Returns {@code true} if sorting is allowed.
`setAllowSorting(allow: boolean)`	Sets whether sorting is allowed.
`getAllowFiltering()` → `boolean`	Returns {@code true} if using AutoFilter is allowed.
`setAllowFiltering(allow: boolean)`	Sets whether using AutoFilter is allowed.
`getAllowUsingPivotTable()` → `boolean`	Returns {@code true} if using pivot tables is allowed.
`setAllowUsingPivotTable(allow: boolean)`	Sets whether using pivot tables is allowed.
`getAllowSelectingUnlockedCell()` → `boolean`	Returns {@code true} if selecting unlocked cells is allowed.
`setAllowSelectingUnlockedCell(allow: boolean)`	Sets whether selecting unlocked cells is allowed.

WorksheetProtection

Overview

Properties

Methods

See Also