Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
PDFKit.isLocked
Returns a Boolean value indicating whether the document is locked.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
PDFKit | 2.9 | ✅ Yes | ❌ No | ❌ No | ✅ Yes, on macOS | ✅ Yes |
Parameters
Parameter | Description | Example |
---|---|---|
A container value with the PDF content from a media field. Or a text with an URL. Or a PDF reference from PDFKit.Open. |
Result
Returns 1 if PDF is locked.
Description
Returns a Boolean value indicating whether the document is locked.Only encrypted documents can be locked. Encrypted documents whose password is the empty string are unlocked automatically upon opening, because PDF Kit tries the empty string as a password if none is supplied.
Examples
Shows some properties:
# Load PDF from container
Set Variable [ $pdf ; Value: MBS( "PDFKit.OpenContainer"; Popup Menu::logo ) ]
# Check some properties
Set Variable [ $allowsCopying ; Value: MBS( "PDFKit.allowsCopying"; $PDF ) ]
Set Variable [ $allowsPrinting ; Value: MBS( "PDFKit.allowsPrinting"; $PDF ) ]
Set Variable [ $isEncrypted ; Value: MBS( "PDFKit.isEncrypted"; $PDF ) ]
Set Variable [ $isLocked ; Value: MBS( "PDFKit.isLocked"; $PDF ) ]
# show in dialog
Show Custom Dialog [ "PDF Details" ; "allows copying: " & If($allowsCopying; "yes"; "no") & ¶ &
"allows printing: " & If($allowsPrinting; "yes"; "no") & ¶ &
"is encrypted: " & If($isEncrypted; "yes"; "no") & ¶ &
"is locked: " & If($isLocked; "yes"; "no")]
# release PDF
Set Variable [ $r ; Value: MBS("PDFKit.Release"; $pdf) ]
See also
- PDFKit.allowsCopying
- PDFKit.allowsPrinting
- PDFKit.isEncrypted
- PDFKit.Open
- PDFKit.OpenContainer
- PDFKit.Release
This function checks for a license.
Created 18th August 2014, last changed 25th November 2019