Protection (Aspose.Cells for Java)

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.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
 
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //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);

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`copy(Protection source)` Copy protection info.
`boolean`	`getAllowDeletingColumn()` Represents if the deletion of columns is allowed on a protected worksheet.
`boolean`	`getAllowDeletingRow()` Represents if the deletion of rows is allowed on a protected worksheet.
`boolean`	`getAllowEditingContent()` Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
`boolean`	`getAllowEditingObject()` Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
`boolean`	`getAllowEditingScenario()` Represents if the user is allowed to edit scenarios on a protected worksheet.
`boolean`	`getAllowFiltering()` Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
`boolean`	`getAllowFormattingCell()` Represents if the formatting of cells is allowed on a protected worksheet.
`boolean`	`getAllowFormattingColumn()` Represents if the formatting of columns is allowed on a protected worksheet
`boolean`	`getAllowFormattingRow()` Represents if the formatting of rows is allowed on a protected worksheet
`boolean`	`getAllowInsertingColumn()` Represents if the insertion of columns is allowed on a protected worksheet
`boolean`	`getAllowInsertingHyperlink()` Represents if the insertion of hyperlinks is allowed on a protected worksheet
`boolean`	`getAllowInsertingRow()` Represents if the insertion of rows is allowed on a protected worksheet
`boolean`	`getAllowSelectingLockedCell()` Represents if the user is allowed to select locked cells on a protected worksheet.
`boolean`	`getAllowSelectingUnlockedCell()` Represents if the user is allowed to select unlocked cells on a protected worksheet.
`boolean`	`getAllowSorting()` Represents if the sorting option is allowed on a protected worksheet.
`boolean`	`getAllowUsingPivotTable()` Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
`java.lang.String`	`getPassword()` Represents the password to protect the worksheet.
`int`	`getPasswordHash()` Gets the hash of current password.
`boolean`	`isProtectedWithPassword()` Indicates whether the worksheets is protected with password.
`void`	`setAllowDeletingColumn(boolean value)` Represents if the deletion of columns is allowed on a protected worksheet.
`void`	`setAllowDeletingRow(boolean value)` Represents if the deletion of rows is allowed on a protected worksheet.
`void`	`setAllowEditingContent(boolean value)` Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
`void`	`setAllowEditingObject(boolean value)` Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
`void`	`setAllowEditingScenario(boolean value)` Represents if the user is allowed to edit scenarios on a protected worksheet.
`void`	`setAllowFiltering(boolean value)` Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
`void`	`setAllowFormattingCell(boolean value)` Represents if the formatting of cells is allowed on a protected worksheet.
`void`	`setAllowFormattingColumn(boolean value)` Represents if the formatting of columns is allowed on a protected worksheet
`void`	`setAllowFormattingRow(boolean value)` Represents if the formatting of rows is allowed on a protected worksheet
`void`	`setAllowInsertingColumn(boolean value)` Represents if the insertion of columns is allowed on a protected worksheet
`void`	`setAllowInsertingHyperlink(boolean value)` Represents if the insertion of hyperlinks is allowed on a protected worksheet
`void`	`setAllowInsertingRow(boolean value)` Represents if the insertion of rows is allowed on a protected worksheet
`void`	`setAllowSelectingLockedCell(boolean value)` Represents if the user is allowed to select locked cells on a protected worksheet.
`void`	`setAllowSelectingUnlockedCell(boolean value)` Represents if the user is allowed to select unlocked cells on a protected worksheet.
`void`	`setAllowSorting(boolean value)` Represents if the sorting option is allowed on a protected worksheet.
`void`	`setAllowUsingPivotTable(boolean value)` Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
`void`	`setPassword(java.lang.String value)` Represents the password to protect the worksheet.
`boolean`	`verifyPassword(java.lang.String password)` Verifies password.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - copy
```
public void copy(Protection source)
```
    Copy protection info.
    
    Parameters:
    source -
  - getAllowDeletingColumn
```
public boolean getAllowDeletingColumn()
```
    Represents if the deletion of columns is allowed on a protected worksheet.
    Remarks
    The columns containing the cells to be deleted must be unlocked when the sheet is protected, and "Select unlocked cells" option must be enabled.
  - setAllowDeletingColumn
```
public void setAllowDeletingColumn(boolean value)
```
    Represents if the deletion of columns is allowed on a protected worksheet.
    Remarks
    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
```
public boolean getAllowDeletingRow()
```
    Represents if the deletion of rows is allowed on a protected worksheet.
    Remarks
    The rows containing the cells to be deleted must be unlocked when the sheet is protected, and "Select unlocked cells" option must be enabled.
  - setAllowDeletingRow
```
public void setAllowDeletingRow(boolean value)
```
    Represents if the deletion of rows is allowed on a protected worksheet.
    Remarks
    The rows containing the cells to be deleted must be unlocked when the sheet is protected, and "Select unlocked cells" option must be enabled.
  - getAllowFiltering
```
public boolean getAllowFiltering()
```
    Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
  - setAllowFiltering
```
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.
  - getAllowFormattingCell
```
public boolean getAllowFormattingCell()
```
    Represents if the formatting of cells is allowed on a protected worksheet.
  - setAllowFormattingCell
```
public void setAllowFormattingCell(boolean value)
```
    Represents if the formatting of cells is allowed on a protected worksheet.
  - getAllowFormattingColumn
```
public boolean getAllowFormattingColumn()
```
    Represents if the formatting of columns is allowed on a protected worksheet
  - setAllowFormattingColumn
```
public void setAllowFormattingColumn(boolean value)
```
    Represents if the formatting of columns is allowed on a protected worksheet
  - getAllowFormattingRow
```
public boolean getAllowFormattingRow()
```
    Represents if the formatting of rows is allowed on a protected worksheet
  - setAllowFormattingRow
```
public void setAllowFormattingRow(boolean value)
```
    Represents if the formatting of rows is allowed on a protected worksheet
  - getAllowInsertingColumn
```
public boolean getAllowInsertingColumn()
```
    Represents if the insertion of columns is allowed on a protected worksheet
  - setAllowInsertingColumn
```
public void setAllowInsertingColumn(boolean value)
```
    Represents if the insertion of columns is allowed on a protected worksheet
  - getAllowInsertingHyperlink
```
public boolean getAllowInsertingHyperlink()
```
    Represents if the insertion of hyperlinks is allowed on a protected worksheet
  - setAllowInsertingHyperlink
```
public void setAllowInsertingHyperlink(boolean value)
```
    Represents if the insertion of hyperlinks is allowed on a protected worksheet
  - getAllowInsertingRow
```
public boolean getAllowInsertingRow()
```
    Represents if the insertion of rows is allowed on a protected worksheet
  - setAllowInsertingRow
```
public void setAllowInsertingRow(boolean value)
```
    Represents if the insertion of rows is allowed on a protected worksheet
  - getAllowSorting
```
public boolean getAllowSorting()
```
    Represents if the sorting option is allowed on a protected worksheet.
  - setAllowSorting
```
public void setAllowSorting(boolean value)
```
    Represents if the sorting option is allowed on a protected worksheet.
  - getAllowUsingPivotTable
```
public boolean getAllowUsingPivotTable()
```
    Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
  - setAllowUsingPivotTable
```
public void setAllowUsingPivotTable(boolean value)
```
    Represents if the user is allowed to manipulate pivot tables on a protected worksheet.
  - getAllowEditingContent
```
public boolean getAllowEditingContent()
```
    Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
  - setAllowEditingContent
```
public void setAllowEditingContent(boolean value)
```
    Represents if the user is allowed to edit contents of locked cells on a protected worksheet.
  - getAllowEditingObject
```
public boolean getAllowEditingObject()
```
    Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
  - setAllowEditingObject
```
public void setAllowEditingObject(boolean value)
```
    Represents if the user is allowed to manipulate drawing objects on a protected worksheet.
  - getAllowEditingScenario
```
public boolean getAllowEditingScenario()
```
    Represents if the user is allowed to edit scenarios on a protected worksheet.
  - setAllowEditingScenario
```
public void setAllowEditingScenario(boolean value)
```
    Represents if the user is allowed to edit scenarios on a protected worksheet.
  - getAllowSelectingLockedCell
```
public boolean getAllowSelectingLockedCell()
```
    Represents if the user is allowed to select locked cells on a protected worksheet.
  - setAllowSelectingLockedCell
```
public void setAllowSelectingLockedCell(boolean value)
```
    Represents if the user is allowed to select locked cells on a protected worksheet.
  - getAllowSelectingUnlockedCell
```
public boolean getAllowSelectingUnlockedCell()
```
    Represents if the user is allowed to select unlocked cells on a protected worksheet.
  - setAllowSelectingUnlockedCell
```
public void setAllowSelectingUnlockedCell(boolean value)
```
    Represents if the user is allowed to select unlocked cells on a protected worksheet.
  - getPassword
```
public java.lang.String getPassword()
```
    Represents the password to protect the worksheet.
    Remarks
    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.
  - setPassword
```
public void setPassword(java.lang.String value)
```
    Represents the password to protect the worksheet.
    Remarks
    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.
  - verifyPassword
```
public boolean verifyPassword(java.lang.String password)
```
    Verifies password.
    
    Parameters:
    password - The password.
    
    Returns:
  - getPasswordHash
```
public int getPasswordHash()
```
    Gets the hash of current password.

Class Protection

Method Summary

Methods inherited from class java.lang.Object

Method Detail

copy

getAllowDeletingColumn

setAllowDeletingColumn

getAllowDeletingRow

setAllowDeletingRow

getAllowFiltering

setAllowFiltering

getAllowFormattingCell

setAllowFormattingCell

getAllowFormattingColumn

setAllowFormattingColumn

getAllowFormattingRow

setAllowFormattingRow

getAllowInsertingColumn

setAllowInsertingColumn

getAllowInsertingHyperlink

setAllowInsertingHyperlink

getAllowInsertingRow

setAllowInsertingRow

getAllowSorting

setAllowSorting

getAllowUsingPivotTable

setAllowUsingPivotTable

getAllowEditingContent

setAllowEditingContent

getAllowEditingObject

setAllowEditingObject

getAllowEditingScenario

setAllowEditingScenario

getAllowSelectingLockedCell

setAllowSelectingLockedCell

getAllowSelectingUnlockedCell

setAllowSelectingUnlockedCell

getPassword

setPassword

isProtectedWithPassword

verifyPassword

getPasswordHash