Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

PDFKit.allowsPrinting

Returns a Boolean value indicating whether the document allows printing.

Component Version macOS Windows Linux Server iOS SDK
PDFKit 2.9 ✅ Yes ❌ No ❌ No ✅ Yes, on macOS ✅ Yes
MBS( "PDFKit.allowsPrinting"; PDF )   More

Parameters

Parameter Description Example
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 printing is allowed and 0 else.

Description

Returns a Boolean value indicating whether the document allows printing.
The ability to print a PDF document is an attribute unrelated to whether the document is locked or unlocked. It depends on the PDF permissions set by the document's author.
This method only determines the desired permissions setting in the PDF document; it is up to the application to enforce (or ignore) the permissions.
This method always returns 1 if the document is not encrypted. Note that in many cases an encrypted document may still be readable by all users due to the standard empty string password. For more details about user and owner passwords, see the Adobe PDF specification.

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

This function checks for a license.

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


PDFKit.allowsCopying - PDFKit.isEncrypted