com.aspose.cells

Class Protection

  • java.lang.Object
    • com.aspose.cells.Protection
public class Protection 
extends java.lang.Object

Represents the various types of protection options available for a worksheet. Only used in ExcelXP and above version.

Example:

//Allowing users to select locked cells of the worksheet
worksheet.getProtection().setAllowSelectingLockedCell(true);
//Allowing users to select unlocked cells of the worksheet
worksheet.getProtection().setAllowSelectingUnlockedCell(true);

Property Getters/Setters Summary
booleangetAllowDeletingColumn()
void
Represents if the deletion of columns is allowed on a protected worksheet.
booleangetAllowDeletingRow()
void
setAllowDeletingRow(booleanvalue)
Represents if the deletion of rows is allowed on a protected worksheet.
booleangetAllowEditingContent()
void
Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
booleangetAllowEditingObject()
void
setAllowEditingObject(booleanvalue)
Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
booleangetAllowEditingScenario()
void
Represents if the user is allowed to edit scenarios on a protected worksheet.
booleangetAllowFiltering()
void
setAllowFiltering(booleanvalue)
Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
booleangetAllowFormattingCell()
void
Represents if the formatting of cells is allowed on a protected worksheet.
booleangetAllowFormattingColumn()
void
Represents if the formatting of columns is allowed on a protected worksheet
booleangetAllowFormattingRow()
void
setAllowFormattingRow(booleanvalue)
Represents if the formatting of rows is allowed on a protected worksheet
booleangetAllowInsertingColumn()
void
Represents if the insertion of columns is allowed on a protected worksheet
booleangetAllowInsertingHyperlink()
void
Represents if the insertion of hyperlinks is allowed on a protected worksheet
booleangetAllowInsertingRow()
void
setAllowInsertingRow(booleanvalue)
Represents if the insertion of rows is allowed on a protected worksheet
booleangetAllowSelectingLockedCell()
void
Represents if the user is allowed to select locked cells on a protected worksheet.
booleangetAllowSelectingUnlockedCell()
void
Represents if the user is allowed to select unlocked cells on a protected worksheet.
booleangetAllowSorting()
void
setAllowSorting(booleanvalue)
Represents if the sorting option is allowed on a protected worksheet.
booleangetAllowUsingPivotTable()
void
Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
booleanisDeletingColumnsAllowed()
void
Represents if the deletion of columns is allowed on a protected worksheet.
booleanisDeletingRowsAllowed()
void
Represents if the deletion of rows is allowed on a protected worksheet.
booleanisEditingContentsAllowed()
void
Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
booleanisEditingObjectsAllowed()
void
Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
booleanisEditingScenariosAllowed()
void
Represents if the user is allowed to edit scenarios on a protected worksheet.
booleanisFilteringAllowed()
void
setFilteringAllowed(booleanvalue)
Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
booleanisFormattingCellsAllowed()
void
Represents if the formatting of cells is allowed on a protected worksheet.
booleanisFormattingColumnsAllowed()
void
Represents if the formatting of columns is allowed on a protected worksheet
booleanisFormattingRowsAllowed()
void
Represents if the formatting of rows is allowed on a protected worksheet
booleanisInsertingColumnsAllowed()
void
Represents if the insertion of columns is allowed on a protected worksheet
booleanisInsertingHyperlinksAllowed()
void
Represents if the insertion of hyperlinks is allowed on a protected worksheet
booleanisInsertingRowsAllowed()
void
Represents if the insertion of rows is allowed on a protected worksheet
booleanisProtectedWithPassword()
Indicates whether the worksheets is protected with password.
booleanisSelectingLockedCellsAllowed()
void
Represents if the user is allowed to select locked cells on a protected worksheet.
booleanisSelectingUnlockedCellsAllowed()
void
Represents if the user is allowed to select unlocked cells on a protected worksheet.
booleanisSortingAllowed()
void
setSortingAllowed(booleanvalue)
Represents if the sorting option is allowed on a protected worksheet.
booleanisUsingPivotTablesAllowed()
void
Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
java.lang.StringgetPassword()
void
setPassword(java.lang.Stringvalue)
Represents the password to protect the worksheet.
 
Method Summary
voidcopy(Protection source)
Copy protection info.
intgetPasswordHash()
Gets the hash of current password.
booleanverifyPassword(java.lang.Stringpassword)
Verifies password.
 

    • Property Getters/Setters Detail

      • getAllowDeletingColumn/setAllowDeletingColumn

        public boolean getAllowDeletingColumn() / public void setAllowDeletingColumn(boolean value)
        
        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.
      • isDeletingColumnsAllowed/setDeletingColumnsAllowed

        public boolean isDeletingColumnsAllowed() / public void setDeletingColumnsAllowed(boolean value)
        
        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.
      • getAllowDeletingRow/setAllowDeletingRow

        public boolean getAllowDeletingRow() / public void setAllowDeletingRow(boolean value)
        
        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.
      • isDeletingRowsAllowed/setDeletingRowsAllowed

        public boolean isDeletingRowsAllowed() / public void setDeletingRowsAllowed(boolean value)
        
        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.
      • getAllowFiltering/setAllowFiltering

        public boolean getAllowFiltering() / public void setAllowFiltering(boolean value)
        
        Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
      • isFilteringAllowed/setFilteringAllowed

        public boolean isFilteringAllowed() / public void setFilteringAllowed(boolean value)
        
        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.
      • getAllowFormattingCell/setAllowFormattingCell

        public boolean getAllowFormattingCell() / public void setAllowFormattingCell(boolean value)
        
        Represents if the formatting of cells is allowed on a protected worksheet.
      • isFormattingCellsAllowed/setFormattingCellsAllowed

        public boolean isFormattingCellsAllowed() / public void setFormattingCellsAllowed(boolean value)
        
        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.
      • getAllowFormattingColumn/setAllowFormattingColumn

        public boolean getAllowFormattingColumn() / public void setAllowFormattingColumn(boolean value)
        
        Represents if the formatting of columns is allowed on a protected worksheet
      • isFormattingColumnsAllowed/setFormattingColumnsAllowed

        public boolean isFormattingColumnsAllowed() / public void setFormattingColumnsAllowed(boolean value)
        
        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.
      • getAllowFormattingRow/setAllowFormattingRow

        public boolean getAllowFormattingRow() / public void setAllowFormattingRow(boolean value)
        
        Represents if the formatting of rows is allowed on a protected worksheet
      • isFormattingRowsAllowed/setFormattingRowsAllowed

        public boolean isFormattingRowsAllowed() / public void setFormattingRowsAllowed(boolean value)
        
        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.
      • getAllowInsertingColumn/setAllowInsertingColumn

        public boolean getAllowInsertingColumn() / public void setAllowInsertingColumn(boolean value)
        
        Represents if the insertion of columns is allowed on a protected worksheet
      • isInsertingColumnsAllowed/setInsertingColumnsAllowed

        public boolean isInsertingColumnsAllowed() / public void setInsertingColumnsAllowed(boolean value)
        
        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.
      • getAllowInsertingHyperlink/setAllowInsertingHyperlink

        public boolean getAllowInsertingHyperlink() / public void setAllowInsertingHyperlink(boolean value)
        
        Represents if the insertion of hyperlinks is allowed on a protected worksheet
      • isInsertingHyperlinksAllowed/setInsertingHyperlinksAllowed

        public boolean isInsertingHyperlinksAllowed() / public void setInsertingHyperlinksAllowed(boolean value)
        
        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.
      • getAllowInsertingRow/setAllowInsertingRow

        public boolean getAllowInsertingRow() / public void setAllowInsertingRow(boolean value)
        
        Represents if the insertion of rows is allowed on a protected worksheet
      • isInsertingRowsAllowed/setInsertingRowsAllowed

        public boolean isInsertingRowsAllowed() / public void setInsertingRowsAllowed(boolean value)
        
        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.
      • getAllowSorting/setAllowSorting

        public boolean getAllowSorting() / public void setAllowSorting(boolean value)
        
        Represents if the sorting option is allowed on a protected worksheet.
      • isSortingAllowed/setSortingAllowed

        public boolean isSortingAllowed() / public void setSortingAllowed(boolean value)
        
        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.
      • getAllowUsingPivotTable/setAllowUsingPivotTable

        public boolean getAllowUsingPivotTable() / public void setAllowUsingPivotTable(boolean value)
        
        Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
      • isUsingPivotTablesAllowed/setUsingPivotTablesAllowed

        public boolean isUsingPivotTablesAllowed() / public void setUsingPivotTablesAllowed(boolean value)
        
        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.
      • getAllowEditingContent/setAllowEditingContent

        public boolean getAllowEditingContent() / public void setAllowEditingContent(boolean value)
        
        Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
      • isEditingContentsAllowed/setEditingContentsAllowed

        public boolean isEditingContentsAllowed() / public void setEditingContentsAllowed(boolean value)
        
        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.
      • getAllowEditingObject/setAllowEditingObject

        public boolean getAllowEditingObject() / public void setAllowEditingObject(boolean value)
        
        Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
      • isEditingObjectsAllowed/setEditingObjectsAllowed

        public boolean isEditingObjectsAllowed() / public void setEditingObjectsAllowed(boolean value)
        
        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.
      • getAllowEditingScenario/setAllowEditingScenario

        public boolean getAllowEditingScenario() / public void setAllowEditingScenario(boolean value)
        
        Represents if the user is allowed to edit scenarios on a protected worksheet.
      • isEditingScenariosAllowed/setEditingScenariosAllowed

        public boolean isEditingScenariosAllowed() / public void setEditingScenariosAllowed(boolean value)
        
        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.
      • getPassword/setPassword

        public java.lang.String getPassword() / public void setPassword(java.lang.String value)
        
        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.
      • isProtectedWithPassword

        public boolean isProtectedWithPassword()
        
        Indicates whether the worksheets is protected with password.
      • getAllowSelectingLockedCell/setAllowSelectingLockedCell

        public boolean getAllowSelectingLockedCell() / public void setAllowSelectingLockedCell(boolean value)
        
        Represents if the user is allowed to select locked cells on a protected worksheet.
      • isSelectingLockedCellsAllowed/setSelectingLockedCellsAllowed

        public boolean isSelectingLockedCellsAllowed() / public void setSelectingLockedCellsAllowed(boolean value)
        
        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.
      • getAllowSelectingUnlockedCell/setAllowSelectingUnlockedCell

        public boolean getAllowSelectingUnlockedCell() / public void setAllowSelectingUnlockedCell(boolean value)
        
        Represents if the user is allowed to select unlocked cells on a protected worksheet.
      • isSelectingUnlockedCellsAllowed/setSelectingUnlockedCellsAllowed

        public boolean isSelectingUnlockedCellsAllowed() / public void setSelectingUnlockedCellsAllowed(boolean value)
        
        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.
    • Method Detail

      • copy

        public void copy(Protection source)
        Copy protection info.
        Parameters:
        source -
      • getPasswordHash

        public int getPasswordHash()
        Gets the hash of current password.
      • verifyPassword

        public boolean verifyPassword(java.lang.String password)
        Verifies password.
        Parameters:
        password - The password.
        Returns: