Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 9.1   9.2   9.3   9.4   9.5   10.0   10.1   10.2   10.3   10.4    Statistic  

PDFKit.isLocked

Returns a Boolean value indicating whether the document is locked.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
PDFKit 2.9 Yes No Yes, macOS only No Yes
MBS( "PDFKit.isLocked"; PDF )   More

Parameters

Parameter Description Example value
PDF 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

Created 18th August 2014, last changed 25th November 2019


PDFKit.isEncrypted   -   PHP.Execute

Feedback: Report problem or ask question.




Links
MBS Xojo PDF Plugins