ProtectionManager

Inheritance: java.lang.Object

All Implemented Interfaces: com.aspose.slides.IProtectionManager

public final class ProtectionManager implements IProtectionManager

Presentation password protection management.

Methods

Method Description
getEncryptDocumentProperties() This property makes sense, if presentation is password protected.
setEncryptDocumentProperties(boolean value) This property makes sense, if presentation is password protected.
isEncrypted() Gets a value indicating whether this instance is encrypted.
isOnlyDocumentPropertiesLoaded() This property makes sense, if presentation file is password protected and document properties of this file are public.
isWriteProtected() Gets a value indicating whether this presentation is write protected.
encrypt(String encryptionPassword) Encrypts Presentation with specified password.
removeEncryption() Removes the encryption.
setWriteProtection(String password) Set write protection for this presentation with specified password.
removeWriteProtection() Removes write protection for this presentation.
checkWriteProtection(String password) Determines whether a presentation is a password protected to modify.
getEncryptionPassword() Gets the password which is used for presentation encryption.
getReadOnlyRecommended() Gets or sets read-only recommendation.
setReadOnlyRecommended(boolean value) Gets or sets read-only recommendation.

getEncryptDocumentProperties()

public final boolean getEncryptDocumentProperties()

This property makes sense, if presentation is password protected. If true then document properties is encrypted in presentation file. If false then document properties is public while presentation is encrypted. Read/write boolean.

Returns: boolean

setEncryptDocumentProperties(boolean value)

public final void setEncryptDocumentProperties(boolean value)

This property makes sense, if presentation is password protected. If true then document properties is encrypted in presentation file. If false then document properties is public while presentation is encrypted. Read/write boolean.

Parameters:

Parameter Type Description
value boolean

isEncrypted()

public final boolean isEncrypted()

Gets a value indicating whether this instance is encrypted. Read-only boolean.

Value: true if presentation was loaded from encrypted file or #encrypt(String).encrypt(String) method was called ; otherwise, false.

Returns: boolean

isOnlyDocumentPropertiesLoaded()

public final boolean isOnlyDocumentPropertiesLoaded()

This property makes sense, if presentation file is password protected and document properties of this file are public. Value of true means that only document properties are loaded from an encrypted presentation file without use of password. Value of false means that entire encrypted presentation is loaded with use of right password, not only document properties are loaded. If presentation isn’t encrypted then property value is always false. If document properties of an encrypted file aren’t public then property value is always false. If Presentation.EncryptDocumentProperties is true than IsOnlyDocumentPropertiesLoaded property value is always false. Read-only boolean.

Returns: boolean

isWriteProtected()

public final boolean isWriteProtected()

Gets a value indicating whether this presentation is write protected. Read-only boolean.

Returns: boolean

encrypt(String encryptionPassword)

public final void encrypt(String encryptionPassword)

Encrypts Presentation with specified password.

Parameters:

Parameter Type Description
encryptionPassword java.lang.String The password.

removeEncryption()

public final void removeEncryption()

Removes the encryption.

setWriteProtection(String password)

public final void setWriteProtection(String password)

Set write protection for this presentation with specified password.

Parameters:

Parameter Type Description
password java.lang.String The password.

removeWriteProtection()

public final void removeWriteProtection()

Removes write protection for this presentation.

checkWriteProtection(String password)

public final boolean checkWriteProtection(String password)

Determines whether a presentation is a password protected to modify.


Presentation presentation = new Presentation(presentationFilePath);
 try {
     boolean isWriteProtected = presentation.getProtectionManager().checkWriteProtection("my_password");
 } finally {
     if (presentation != null) presentation.dispose();
 }

Parameters:

Parameter Type Description
password java.lang.String The password for checking.

  1. You should check the (#isWriteProtected.isWriteProtected) property before calling this method. 2. When the password is null or empty, this method returns false. |

Returns: boolean - True if the password is valid; otherwise, false.

getEncryptionPassword()

public final String getEncryptionPassword()

Gets the password which is used for presentation encryption. Read-only String.

Returns: java.lang.String

getReadOnlyRecommended()

public final boolean getReadOnlyRecommended()

Gets or sets read-only recommendation. Read/write boolean.


Presentation pres = new Presentation();
 pres.getProtectionManager().setReadOnlyRecommended(true);
 pres.save("ReadOnlyPresentation.pptx", SaveFormat.Pptx);

Returns: boolean

setReadOnlyRecommended(boolean value)

public final void setReadOnlyRecommended(boolean value)

Gets or sets read-only recommendation. Read/write boolean.


Presentation pres = new Presentation();
 pres.getProtectionManager().setReadOnlyRecommended(true);
 pres.save("ReadOnlyPresentation.pptx", SaveFormat.Pptx);

Parameters:

Parameter Type Description
value boolean