com.aspose.slides

Interfaces

Classes

Exceptions

com.aspose.slides

Interface IProtectionManager

  • All Known Implementing Classes:
    ProtectionManager


    public interface IProtectionManager

    Presentation password protestion management.

    • Method Detail

      • getEncryptDocumentProperties

        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.

      • setEncryptDocumentProperties

        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.

      • isEncrypted

        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) method was called ; otherwise, false.
      • isOnlyDocumentPropertiesLoaded

        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 PresentationEx.EncryptDocumentProperties is true than IsOnlyDocumentPropertiesLoaded property value is always false. Read-only boolean.

      • isWriteProtected

        boolean isWriteProtected()

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

      • getEncryptionPassword

        java.lang.String getEncryptionPassword()

        Returns encryption password. Read-only String.

      • getReadOnlyRecommended

        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);
         
      • setReadOnlyRecommended

        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);
         
      • encrypt

        void encrypt(java.lang.String encryptionPassword)

        Encrypts Presentation with specified password.

        Parameters:
        encryptionPassword - The password.
      • removeEncryption

        void removeEncryption()

        Removes the encryption.

      • setWriteProtection

        void setWriteProtection(java.lang.String password)

        Set write protection for this presentation with specified password.

        Parameters:
        password - The password.
      • removeWriteProtection

        void removeWriteProtection()

        Removes write protection for this presentation.

      • checkWriteProtection

        boolean checkWriteProtection(java.lang.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:
        password - 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:
        True if the password is valid; otherwise, false.