PdfEncryptionDetails class

Contains details for encrypting and access permissions for a PDF document.

To learn more, visit the Protect or Encrypt a Document documentation article.

public class PdfEncryptionDetails


PdfEncryptionDetails(string, string)Initializes an instance of this class.
PdfEncryptionDetails(string, string, PdfPermissions)Initializes an instance of this class.


OwnerPassword { get; set; }Specifies the owner password for the encrypted PDF document.
Permissions { get; set; }Specifies the operations that are allowed to a user on an encrypted PDF document. The default value is DisallowAll.
UserPassword { get; set; }Specifies the user password required for opening the encrypted PDF document.


Shows how to set permissions on a saved PDF document.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Writeln("Hello world!");

// Extend permissions to allow the editing of annotations.
PdfEncryptionDetails encryptionDetails =
    new PdfEncryptionDetails("password", string.Empty, PdfPermissions.ModifyAnnotations | PdfPermissions.DocumentAssembly);

// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions saveOptions = new PdfSaveOptions();
// Enable encryption via the "EncryptionDetails" property.
saveOptions.EncryptionDetails = encryptionDetails;

// When we open this document, we will need to provide the password before accessing its contents.
doc.Save(ArtifactsDir + "PdfSaveOptions.EncryptionPermissions.pdf", saveOptions);

See Also