Protection
Source: aspose.
Represents the various types of protection options available for a worksheet.
Methods
- copy(source)
- getAllowDeletingColumn()
- getAllowDeletingRow()
- getAllowEditingContent()
- getAllowEditingObject()
- getAllowEditingScenario()
- getAllowFiltering()
- getAllowFormattingCell()
- getAllowFormattingColumn()
- getAllowFormattingRow()
- getAllowInsertingColumn()
- getAllowInsertingHyperlink()
- getAllowInsertingRow()
- getAllowSelectingLockedCell()
- getAllowSelectingUnlockedCell()
- getAllowSorting()
- getAllowUsingPivotTable()
- getPassword()
- getPasswordHash()
- isDeletingColumnsAllowed()
- isDeletingRowsAllowed()
- isEditingContentsAllowed()
- isEditingObjectsAllowed()
- isEditingScenariosAllowed()
- isFilteringAllowed()
- isFormattingCellsAllowed()
- isFormattingColumnsAllowed()
- isFormattingRowsAllowed()
- isInsertingColumnsAllowed()
- isInsertingHyperlinksAllowed()
- isInsertingRowsAllowed()
- isProtectedWithPassword()
- isSelectingLockedCellsAllowed()
- isSelectingUnlockedCellsAllowed()
- isSortingAllowed()
- isUsingPivotTablesAllowed()
- setAllowDeletingColumn()
- setAllowDeletingRow()
- setAllowEditingContent()
- setAllowEditingObject()
- setAllowEditingScenario()
- setAllowFiltering()
- setAllowFormattingCell()
- setAllowFormattingColumn()
- setAllowFormattingRow()
- setAllowInsertingColumn()
- setAllowInsertingHyperlink()
- setAllowInsertingRow()
- setAllowSelectingLockedCell()
- setAllowSelectingUnlockedCell()
- setAllowSorting()
- setAllowUsingPivotTable()
- setDeletingColumnsAllowed()
- setDeletingRowsAllowed()
- setEditingContentsAllowed()
- setEditingObjectsAllowed()
- setEditingScenariosAllowed()
- setFilteringAllowed()
- setFormattingCellsAllowed()
- setFormattingColumnsAllowed()
- setFormattingRowsAllowed()
- setInsertingColumnsAllowed()
- setInsertingHyperlinksAllowed()
- setInsertingRowsAllowed()
- setPassword()
- setSelectingLockedCellsAllowed()
- setSelectingUnlockedCellsAllowed()
- setSortingAllowed()
- setUsingPivotTablesAllowed()
- verifyPassword(password)
Methods
copy(source)
Copy protection info.
Parameter
Name | Type | Optional | Description |
---|---|---|---|
source |
|
getAllowDeletingColumn()
Represents if the deletion of columns is allowed on a protected worksheet. The columns containing the cells to be deleted must be unlocked when the sheet is protected, and "Select unlocked cells" option must be enabled.
getAllowDeletingRow()
Represents if the deletion of rows is allowed on a protected worksheet. The rows containing the cells to be deleted must be unlocked when the sheet is protected, and "Select unlocked cells" option must be enabled.
getAllowEditingContent()
Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
getAllowEditingObject()
Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
getAllowEditingScenario()
Represents if the user is allowed to edit scenarios on a protected worksheet.
getAllowFiltering()
Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
getAllowFormattingCell()
Represents if the formatting of cells is allowed on a protected worksheet.
getAllowFormattingColumn()
Represents if the formatting of columns is allowed on a protected worksheet
getAllowFormattingRow()
Represents if the formatting of rows is allowed on a protected worksheet
getAllowInsertingColumn()
Represents if the insertion of columns is allowed on a protected worksheet
getAllowInsertingHyperlink()
Represents if the insertion of hyperlinks is allowed on a protected worksheet
getAllowInsertingRow()
Represents if the insertion of rows is allowed on a protected worksheet
getAllowSelectingLockedCell()
Represents if the user is allowed to select locked cells on a protected worksheet.
getAllowSelectingUnlockedCell()
Represents if the user is allowed to select unlocked cells on a protected worksheet.
getAllowSorting()
Represents if the sorting option is allowed on a protected worksheet.
getAllowUsingPivotTable()
Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
getPassword()
Represents the password to protect the worksheet. If password is set to null or blank string, you can unprotect the worksheet or workbook without using a password. Otherwise, you must specify the password to unprotect the worksheet or workbook.
getPasswordHash()
Gets the hash of current password.
isDeletingColumnsAllowed()
Represents if the deletion of columns is allowed on a protected worksheet. The columns containing the cells to be deleted must be unlocked when the sheet is protected, and "Select unlocked cells" option must be enabled. NOTE: This member is now obsolete. Instead, please use Protection.AllowDeletingColumn property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isDeletingRowsAllowed()
Represents if the deletion of rows is allowed on a protected worksheet. The rows containing the cells to be deleted must be unlocked when the sheet is protected, and "Select unlocked cells" option must be enabled. NOTE: This member is now obsolete. Instead, please use Protection.AllowDeletingRow property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isEditingContentsAllowed()
Represents if the user is allowed to edit contents of locked cells on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowEditingContent property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isEditingObjectsAllowed()
Represents if the user is allowed to manipulate drawing objects on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowEditingObject property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isEditingScenariosAllowed()
Represents if the user is allowed to edit scenarios on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowEditingScenario property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isFilteringAllowed()
Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected. NOTE: This member is now obsolete. Instead, please use Protection.AllowFiltering property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isFormattingCellsAllowed()
Represents if the formatting of cells is allowed on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowFormattingCell property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isFormattingColumnsAllowed()
Represents if the formatting of columns is allowed on a protected worksheet NOTE: This member is now obsolete. Instead, please use Protection.AllowFormattingColumn property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isFormattingRowsAllowed()
Represents if the formatting of rows is allowed on a protected worksheet NOTE: This member is now obsolete. Instead, please use Protection.AllowFormattingRow property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isInsertingColumnsAllowed()
Represents if the insertion of columns is allowed on a protected worksheet NOTE: This member is now obsolete. Instead, please use Protection.AllowInsertingColumn property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isInsertingHyperlinksAllowed()
Represents if the insertion of hyperlinks is allowed on a protected worksheet NOTE: This member is now obsolete. Instead, please use Protection.AllowInsertingHyperlink property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isInsertingRowsAllowed()
Represents if the insertion of rows is allowed on a protected worksheet NOTE: This member is now obsolete. Instead, please use Protection.AllowInsertingRow property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isProtectedWithPassword()
Indicates whether the worksheets is protected with password.
isSelectingLockedCellsAllowed()
Represents if the user is allowed to select locked cells on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowSelectingLockedCell property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isSelectingUnlockedCellsAllowed()
Represents if the user is allowed to select unlocked cells on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowSelectingUnlockedCell property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isSortingAllowed()
Represents if the sorting option is allowed on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowSorting property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
isUsingPivotTablesAllowed()
Represents if the user is allowed to manipulate pivot tables on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowUsingPivotTable property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setAllowDeletingColumn()
Represents if the deletion of columns is allowed on a protected worksheet. The columns containing the cells to be deleted must be unlocked when the sheet is protected, and "Select unlocked cells" option must be enabled.
setAllowDeletingRow()
Represents if the deletion of rows is allowed on a protected worksheet. The rows containing the cells to be deleted must be unlocked when the sheet is protected, and "Select unlocked cells" option must be enabled.
setAllowEditingContent()
Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
setAllowEditingObject()
Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
setAllowEditingScenario()
Represents if the user is allowed to edit scenarios on a protected worksheet.
setAllowFiltering()
Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
setAllowFormattingCell()
Represents if the formatting of cells is allowed on a protected worksheet.
setAllowFormattingColumn()
Represents if the formatting of columns is allowed on a protected worksheet
setAllowFormattingRow()
Represents if the formatting of rows is allowed on a protected worksheet
setAllowInsertingColumn()
Represents if the insertion of columns is allowed on a protected worksheet
setAllowInsertingHyperlink()
Represents if the insertion of hyperlinks is allowed on a protected worksheet
setAllowInsertingRow()
Represents if the insertion of rows is allowed on a protected worksheet
setAllowSelectingLockedCell()
Represents if the user is allowed to select locked cells on a protected worksheet.
setAllowSelectingUnlockedCell()
Represents if the user is allowed to select unlocked cells on a protected worksheet.
setAllowSorting()
Represents if the sorting option is allowed on a protected worksheet.
setAllowUsingPivotTable()
Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
setDeletingColumnsAllowed()
Represents if the deletion of columns is allowed on a protected worksheet. The columns containing the cells to be deleted must be unlocked when the sheet is protected, and "Select unlocked cells" option must be enabled. NOTE: This member is now obsolete. Instead, please use Protection.AllowDeletingColumn property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setDeletingRowsAllowed()
Represents if the deletion of rows is allowed on a protected worksheet. The rows containing the cells to be deleted must be unlocked when the sheet is protected, and "Select unlocked cells" option must be enabled. NOTE: This member is now obsolete. Instead, please use Protection.AllowDeletingRow property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setEditingContentsAllowed()
Represents if the user is allowed to edit contents of locked cells on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowEditingContent property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setEditingObjectsAllowed()
Represents if the user is allowed to manipulate drawing objects on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowEditingObject property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setEditingScenariosAllowed()
Represents if the user is allowed to edit scenarios on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowEditingScenario property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setFilteringAllowed()
Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected. NOTE: This member is now obsolete. Instead, please use Protection.AllowFiltering property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setFormattingCellsAllowed()
Represents if the formatting of cells is allowed on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowFormattingCell property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setFormattingColumnsAllowed()
Represents if the formatting of columns is allowed on a protected worksheet NOTE: This member is now obsolete. Instead, please use Protection.AllowFormattingColumn property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setFormattingRowsAllowed()
Represents if the formatting of rows is allowed on a protected worksheet NOTE: This member is now obsolete. Instead, please use Protection.AllowFormattingRow property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setInsertingColumnsAllowed()
Represents if the insertion of columns is allowed on a protected worksheet NOTE: This member is now obsolete. Instead, please use Protection.AllowInsertingColumn property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setInsertingHyperlinksAllowed()
Represents if the insertion of hyperlinks is allowed on a protected worksheet NOTE: This member is now obsolete. Instead, please use Protection.AllowInsertingHyperlink property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setInsertingRowsAllowed()
Represents if the insertion of rows is allowed on a protected worksheet NOTE: This member is now obsolete. Instead, please use Protection.AllowInsertingRow property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setPassword()
Represents the password to protect the worksheet. If password is set to null or blank string, you can unprotect the worksheet or workbook without using a password. Otherwise, you must specify the password to unprotect the worksheet or workbook.
setSelectingLockedCellsAllowed()
Represents if the user is allowed to select locked cells on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowSelectingLockedCell property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setSelectingUnlockedCellsAllowed()
Represents if the user is allowed to select unlocked cells on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowSelectingUnlockedCell property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setSortingAllowed()
Represents if the sorting option is allowed on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowSorting property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
setUsingPivotTablesAllowed()
Represents if the user is allowed to manipulate pivot tables on a protected worksheet. NOTE: This member is now obsolete. Instead, please use Protection.AllowUsingPivotTable property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
verifyPassword(password) → boolean
Verifies password.
Parameter
Name | Type | Optional | Description |
---|---|---|---|
password |
String |
|
The password. |
- Returns
-
boolean