How Do I Get Notified When a Password-Protected Document Is Unlocked?

Q: If I initialize a PDFViewController with a password-protected document, the documentViewController property is nil until the document is unlocked. Is there a way to be notified when the documentViewController becomes valid?

You can implement PDFViewControllerDelegate.pdfViewController(_:didChange:error:) to get the non-nil document view controller when the document is unlocked, like so:

Swift
Copy
1
2
3
4
5
6
7
8
9
10
11
12

let pdfController = PDFViewController(document: lockedDocument)
pdfController.delegate = self

...

func pdfViewController(_ pdfController: PSPDFViewController, didChange controllerState: PSPDFControllerState, error: Error?) {
    if controllerState == .default {
        if let layout = pdfController.documentViewController?.layout as? ContinuousScrollingLayout {
            layout.fillAlongsideTransverseAxis = true
        }
    }
}
Objective-C
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13

PSPDFViewController *pdfController = [[PSPDFViewController alloc] initWithDocument:lockedDocument];
pdfController.delegate = self;

...

- (void)pdfViewController:(PSPDFViewController *)pdfController didChangeControllerState:(PSPDFControllerState)controllerState error:(nullable NSError *)error {
    if (controllerState == PSPDFControllerStateDefault) {
        PSPDFDocumentViewLayout *layout = pdfController.documentViewController.layout;
        if ([layout isKindOfClass:PSPDFContinuousScrollingLayout.class]) {
            ((PSPDFContinuousScrollingLayout *)layout).fillAlongsideTransverseAxis = YES;
        }
    }
}

Was this page helpful? We're happy to answer any questions.

The PSPDFKit SDK is a framework that allows you to view, annotate, sign, and fill PDF forms on iOS, Android, Windows, macOS, and Web. PSPDFKit Instant adds real-time collaboration features to seamlessly share, edit, and annotate PDF documents.