set_password method
set_password(password)
Sets the write protection password for the document.
def set_password(self, password: str):
...
Parameter | Type | Description |
---|---|---|
password | str | The password to set. Cannot be None , but can be an empty string. |
Remarks
If a password is set, Microsoft Word will require the user to enter it or open the document as read-only.
Examples
Shows how to protect a document with a password.
doc = aw.Document()
builder = aw.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.write_protection.set_password("MyPassword")
doc.write_protection.read_only_recommended = True
self.assertTrue(doc.write_protection.is_write_protected)
self.assertTrue(doc.write_protection.validate_password("MyPassword"))
# Protection does not prevent the document from being edited programmatically, nor does it encrypt the contents.
doc.save(ARTIFACTS_DIR + "Document.write_protection.docx")
doc = aw.Document(ARTIFACTS_DIR + "Document.write_protection.docx")
self.assertTrue(doc.write_protection.is_write_protected)
builder = aw.DocumentBuilder(doc)
builder.move_to_document_end()
builder.writeln("Writing text in a protected document.")
self.assertEqual("Hello world! This document is protected." +
"\rWriting text in a protected document.", doc.get_text().strip())
See Also
- module aspose.words.settings
- class WriteProtection