user_password property

PdfEncryptionDetails.user_password property

Specifies the user password required for opening the encrypted PDF document.

@property
def user_password(self) -> str:
    ...

@user_password.setter
def user_password(self, value: str):
    ...

Remarks

The user password will be required to open an encrypted PDF document for viewing. The permissions specified in PdfEncryptionDetails.permissions will be enforced by the reader software.

The user password can be None or empty string, in this case no password will be required from the user when opening the PDF document. The user password cannot be the same as the owner password.

Examples

Shows how to set permissions on a saved PDF document.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
builder.writeln('Hello world!')
# Extend permissions to allow the editing of annotations.
encryption_details = aw.saving.PdfEncryptionDetails(user_password='password', owner_password='', permissions=aw.saving.PdfPermissions.MODIFY_ANNOTATIONS | aw.saving.PdfPermissions.DOCUMENT_ASSEMBLY)
# Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
# to modify how that method converts the document to .PDF.
save_options = aw.saving.PdfSaveOptions()
# Enable encryption via the "EncryptionDetails" property.
save_options.encryption_details = encryption_details
# When we open this document, we will need to provide the password before accessing its contents.
doc.save(file_name=ARTIFACTS_DIR + 'PdfSaveOptions.EncryptionPermissions.pdf', save_options=save_options)

See Also

PdfEncryptionDetails.permissions property