com.grapecity.documents.excel

Class WriteProtection

java.lang.Object

com.grapecity.documents.excel.WriteProtection

public class WriteProtection
extends java.lang.Object

Provides access to the workbook write protection options.

Constructor Summary

Constructors

Constructor and Description
WriteProtection(IWorkbookForShell workbook)

Method Summary

Modifier and Type	Method and Description
boolean	getReadOnlyRecommended() Gets if the Read Only Recommended option is selected.
boolean	getWriteReserved() Gets whether this workbook is write protected.
java.lang.String	getWriteReservedBy() Gets the name of the user who currently has write permission for the workbook. If you don't explicitly specify this property, the value will come from the IWorkbook.Author, and if the IWorkbook.Author is empty string or null, the value will be "GcExcel".
void	setReadOnlyRecommended(boolean value) Sets if the Read Only Recommended option is selected.
void	setWritePassword(java.lang.String value) Sets the protected password to modify the file.
void	setWriteReservedBy(java.lang.String value) Sets the name of the user who currently has write permission for the workbook.
boolean	validatePassword(java.lang.String password) Returns true if the specified password is the same as the write-protection password the file was protected with.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WriteProtection

public WriteProtection(IWorkbookForShell workbook)

Method Detail

getWriteReservedBy

public java.lang.String getWriteReservedBy()

Gets the name of the user who currently has write permission for the workbook.
If you don't explicitly specify this property, the value will come from the IWorkbook.Author, and if the IWorkbook.Author is empty string or null, the value will be "GcExcel".

setWriteReservedBy

public void setWriteReservedBy(java.lang.String value)

Sets the name of the user who currently has write permission for the workbook.

getReadOnlyRecommended

public boolean getReadOnlyRecommended()

Gets if the Read Only Recommended option is selected.

setReadOnlyRecommended

public void setReadOnlyRecommended(boolean value)

Sets if the Read Only Recommended option is selected.

getWriteReserved

public boolean getWriteReserved()

Gets whether this workbook is write protected.

setWritePassword

public void setWritePassword(java.lang.String value)

Sets the protected password to modify the file.

validatePassword

public boolean validatePassword(java.lang.String password)

Returns true if the specified password is the same as the write-protection password the file was protected with.

Parameters:

password - The specified password..