Instance Property

isUnlocked

Returns whether the specified PDF document is currently unlocked.

Declaration

var isUnlocked: Bool { get }

Parameters

document

A PDF document.

Return Value

A Boolean that, if true, indicates that the document is not locked. If the value is false, the document is locked.

Discussion

There are two possible reasons why a PDF document is unlocked:

  • The document is not encrypted.

  • The document is encrypted, and a valid password was previously specified using unlockWithPassword(_:).

See Also

Working with an Encrypted PDF Document

var isEncrypted: Bool

Returns whether the specified PDF file is encrypted.

var allowsCopying: Bool

Returns whether the specified PDF document allows copying.

var allowsPrinting: Bool

Returns whether a PDF document allows printing.

func unlockWithPassword(UnsafePointer<Int8>) -> Bool

Unlocks an encrypted PDF document when a valid password is supplied.