Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

PdfStandardEncryptionOptions

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision 804a7612eee4 with working tree changes
Modifiers sealed

Options for generated PDF Standard password security.

Inheritance

  • Object
  • PdfStandardEncryptionOptions

Usage

Explore 7 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 2

Accepted by parameters 5

Constructors

public PdfStandardEncryptionOptions(String userPassword) #

Creates Standard security options using the supplied document-open password.

Parameters

userPassword System.String requiredposition: 0

Methods

public PdfStandardEncryptionOptions Clone() #
Returns: PdfStandardEncryptionOptions

Creates a deep copy of the encryption options.

Properties

public String UserPassword { get; set; } #

Password required to open the generated PDF. AES-256 accepts at most 4096 UTF-16 characters before normalization.

public String? OwnerPassword { get; set; } #

Optional owner password. When omitted, the user password is reused. AES-256 accepts at most 4096 UTF-16 characters before normalization.

public PdfStandardEncryptionAlgorithm Algorithm { get; set; } #

Encryption algorithm. AES-256 revision 6 is the default; RC4 requires explicit legacy selection.

public Boolean EncryptMetadata { get; set; } #

Whether document metadata streams are encrypted. Defaults to true.

public IOfficeAesCryptographyProvider? AesCryptographyProvider { get; set; } #

Optional synchronous AES provider used when the host does not expose platform AES-CBC, such as browser WebAssembly. Native platform cryptography remains the default when this property is null.

public Int32 Permissions { get; set; } #

Raw PDF Standard security permission bit mask. Defaults to allowing all standard operations.

public PdfStandardPermissions AllowedPermissions { get; set; } #

Typed view over the Standard security permission mask.

Fields

public const Int32 AllowAllPermissions #

PDF permission bit mask allowing all standard operations.

Value: -4