DsPdfJS API v9.1.0

DsPdfJS API / PdfDecryptionOptions

Type Alias: PdfDecryptionOptions

PdfDecryptionOptions = object

Represents the decryption options used when loading a PDF document.

Properties

password?

optional password: string

The string specifying the password to open a PDF document. Note if both 'password' and 'passwordBytes' are specified then 'passwordBytes' preferred.

passwordBytes?

optional passwordBytes: string

The bytes array specifying the password to open a PDF document. This property is useful when password contains specific regional character which cannot be converted to bytes using UTF8 encoding. Note if both 'password' and 'passwordBytes' are specified then 'passwordBytes' preferred.

throwExceptionIfInvalidPassword?

optional throwExceptionIfInvalidPassword: boolean

Indicating whether to throw an exception if the specified password is invalid. If "false", the document will be opened even if the specified password is invalid, but many methods and properties will not work in this case. Not specified means "true".

throwExceptionIfUnsupportedSecurityOptions?

optional throwExceptionIfUnsupportedSecurityOptions: boolean

Indicating whether to throw an exception if the definition of the security handler is in unknown or invalid format. If "false", the document will be opened even if the security handler cannot be parsed, but many methods and properties will not work in this case. Not specified means "true".