com.aspose.words

Class WriteProtection

  • java.lang.Object
    • com.aspose.words.WriteProtection
  • All Implemented Interfaces:
    java.lang.Cloneable
    public class WriteProtection 
    extends java.lang.Object

Specifies write protection settings for a document.

Write protection specifies whether the author has recommended that the document is to be opened as read-only and/or require a password to modify a document.

Write protection is different from document protection. Write protection is specified in Microsoft Word in the options of the Save As dialog box.

You do not create instances of this class directly. You access document protection settings via the Document.WriteProtection property.

Example:

Shows how to protect a document with a password.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Hello world! This document is protected.");

// Enter a password up to 15 characters in length, and then verify the document's protection status.
doc.getWriteProtection().setPassword("MyPassword");
doc.getWriteProtection().setReadOnlyRecommended(true);

Assert.assertTrue(doc.getWriteProtection().isWriteProtected());
Assert.assertTrue(doc.getWriteProtection().validatePassword("MyPassword"));

// Protection does not prevent the document from being edited programmatically, nor does it encrypt the contents.
doc.save(getArtifactsDir() + "Document.WriteProtection.docx");
doc = new Document(getArtifactsDir() + "Document.WriteProtection.docx");

Assert.assertTrue(doc.getWriteProtection().isWriteProtected());

builder = new DocumentBuilder(doc);
builder.moveToDocumentEnd();
builder.writeln("Writing text in a protected document.");

Assert.assertEquals("Hello world! This document is protected." +
        "\rWriting text in a protected document.", doc.getText().trim());

Property Getters/Setters Summary
booleanisWriteProtected()
Returns true when a write protection password is set.
booleangetReadOnlyRecommended()
void
           Specifies whether the document author has recommended that the document be opened as read-only.
 
Method Summary
voidsetPassword(java.lang.String password)
Sets the write protection password for the document.
booleanvalidatePassword(java.lang.String password)
Returns true if the specified password is the same as the write-protection password the document was protected with. If document is not write-protected with password then returns false.
 

    • Property Getters/Setters Detail

      • isWriteProtected

        public boolean isWriteProtected()
        
        Returns true when a write protection password is set.

        Example:

        Shows how to protect a document with a password.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world! This document is protected.");
        
        // Enter a password up to 15 characters in length, and then verify the document's protection status.
        doc.getWriteProtection().setPassword("MyPassword");
        doc.getWriteProtection().setReadOnlyRecommended(true);
        
        Assert.assertTrue(doc.getWriteProtection().isWriteProtected());
        Assert.assertTrue(doc.getWriteProtection().validatePassword("MyPassword"));
        
        // Protection does not prevent the document from being edited programmatically, nor does it encrypt the contents.
        doc.save(getArtifactsDir() + "Document.WriteProtection.docx");
        doc = new Document(getArtifactsDir() + "Document.WriteProtection.docx");
        
        Assert.assertTrue(doc.getWriteProtection().isWriteProtected());
        
        builder = new DocumentBuilder(doc);
        builder.moveToDocumentEnd();
        builder.writeln("Writing text in a protected document.");
        
        Assert.assertEquals("Hello world! This document is protected." +
                "\rWriting text in a protected document.", doc.getText().trim());
      • getReadOnlyRecommended/setReadOnlyRecommended

        public boolean getReadOnlyRecommended() / public void setReadOnlyRecommended(boolean value)
        
        Specifies whether the document author has recommended that the document be opened as read-only.

        Example:

        Shows how to protect a document with a password.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world! This document is protected.");
        
        // Enter a password up to 15 characters in length, and then verify the document's protection status.
        doc.getWriteProtection().setPassword("MyPassword");
        doc.getWriteProtection().setReadOnlyRecommended(true);
        
        Assert.assertTrue(doc.getWriteProtection().isWriteProtected());
        Assert.assertTrue(doc.getWriteProtection().validatePassword("MyPassword"));
        
        // Protection does not prevent the document from being edited programmatically, nor does it encrypt the contents.
        doc.save(getArtifactsDir() + "Document.WriteProtection.docx");
        doc = new Document(getArtifactsDir() + "Document.WriteProtection.docx");
        
        Assert.assertTrue(doc.getWriteProtection().isWriteProtected());
        
        builder = new DocumentBuilder(doc);
        builder.moveToDocumentEnd();
        builder.writeln("Writing text in a protected document.");
        
        Assert.assertEquals("Hello world! This document is protected." +
                "\rWriting text in a protected document.", doc.getText().trim());
    • Method Detail

      • setPassword

        public void setPassword(java.lang.String password)
        Sets the write protection password for the document.

        If a password is set, Microsoft Word will require the user to enter it or open the document as read-only.

        Parameters:
        password - The password to set. Cannot be null, but can be an empty string.

        Example:

        Shows how to protect a document with a password.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world! This document is protected.");
        
        // Enter a password up to 15 characters in length, and then verify the document's protection status.
        doc.getWriteProtection().setPassword("MyPassword");
        doc.getWriteProtection().setReadOnlyRecommended(true);
        
        Assert.assertTrue(doc.getWriteProtection().isWriteProtected());
        Assert.assertTrue(doc.getWriteProtection().validatePassword("MyPassword"));
        
        // Protection does not prevent the document from being edited programmatically, nor does it encrypt the contents.
        doc.save(getArtifactsDir() + "Document.WriteProtection.docx");
        doc = new Document(getArtifactsDir() + "Document.WriteProtection.docx");
        
        Assert.assertTrue(doc.getWriteProtection().isWriteProtected());
        
        builder = new DocumentBuilder(doc);
        builder.moveToDocumentEnd();
        builder.writeln("Writing text in a protected document.");
        
        Assert.assertEquals("Hello world! This document is protected." +
                "\rWriting text in a protected document.", doc.getText().trim());
      • validatePassword

        public boolean validatePassword(java.lang.String password)
        Returns true if the specified password is the same as the write-protection password the document was protected with. If document is not write-protected with password then returns false.

        Example:

        Shows how to protect a document with a password.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world! This document is protected.");
        
        // Enter a password up to 15 characters in length, and then verify the document's protection status.
        doc.getWriteProtection().setPassword("MyPassword");
        doc.getWriteProtection().setReadOnlyRecommended(true);
        
        Assert.assertTrue(doc.getWriteProtection().isWriteProtected());
        Assert.assertTrue(doc.getWriteProtection().validatePassword("MyPassword"));
        
        // Protection does not prevent the document from being edited programmatically, nor does it encrypt the contents.
        doc.save(getArtifactsDir() + "Document.WriteProtection.docx");
        doc = new Document(getArtifactsDir() + "Document.WriteProtection.docx");
        
        Assert.assertTrue(doc.getWriteProtection().isWriteProtected());
        
        builder = new DocumentBuilder(doc);
        builder.moveToDocumentEnd();
        builder.writeln("Writing text in a protected document.");
        
        Assert.assertEquals("Hello world! This document is protected." +
                "\rWriting text in a protected document.", doc.getText().trim());