Platforms to show: All Mac Windows Linux Cross-Platform
Back to PDFDocumentMBS class.
PDFDocumentMBS.allowsCommenting as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Available in macOS 10.13 or newer.
(Read only property)
PDFDocumentMBS.allowsContentAccessibility as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Available in macOS 10.13 or newer.
(Read only property)
PDFDocumentMBS.allowsCopying as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Even unlocked, encrypted PDF's may have certain restrictions regarding copying or printing placed upon them.
(Read only property)
PDFDocumentMBS.allowsDocumentAssembly as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Available in macOS 10.13 or newer.
(Read only property)
PDFDocumentMBS.allowsDocumentChanges as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Available in macOS 10.13 or newer.
(Read only property)
PDFDocumentMBS.allowsFormFieldEntry as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Available in macOS 10.13 or newer.
(Read only property)
PDFDocumentMBS.allowsPrinting as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Even unlocked, encrypted PDF's may have certain restrictions regarding copying or printing placed upon them.
(Read only property)
PDFDocumentMBS.Author as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
PDFDocumentMBS.CreationDate as Date
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
(Read and Write property)
PDFDocumentMBS.CreationDateTime as DateTime
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 20.5 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
PDFDocumentMBS.Creator as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
PDFDocumentMBS.documentRef as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
This is the CGPDFDocument associated with the PDFDocument object. With this object you can call many CoreGraphics API. May return 0 if the document was not created from an existing PDF file or data.
Use CGPDFDocumentMBS with Constructor taking a handle to call functions on this CGPDFDocument object.
(Read only property)
PDFDocumentMBS.documentURL as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
May return nil if the document was created from data.
(Read only property)
PDFDocumentMBS.Handle as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
PDFDocumentMBS.isEncrypted as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
With the right password, a PDF can be unlocked - nontheless, the PDF still indicates that it is encrypted - just no longer locked. Some PDF's may be encrypted but can be unlocked with the empty string.
These are unlocked automatically.
(Read only property)
PDFDocumentMBS.isFinding as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read only property)
PDFDocumentMBS.isLocked as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
With the right password, a PDF can be unlocked - nontheless, the PDF still indicates that it is encrypted - just no longer locked. Some PDF's may be encrypted but can be unlocked with the empty string.
These are unlocked automatically.
(Read only property)
PDFDocumentMBS.majorVersion as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read only property)
PDFDocumentMBS.minorVersion as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read only property)
PDFDocumentMBS.ModificationDate as Date
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
(Read and Write property)
PDFDocumentMBS.ModificationDateTime as DateTime
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 20.5 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
PDFDocumentMBS.outlineRoot as PDFOutlineMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
Some examples using this property:
PDFDocumentMBS.pageCount as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read only property)
PDFDocumentMBS.permissionsStatus as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
You have kPDFDocumentPermissionsNone status for an encrypted document that you have not supplied either a valid user or owner password. For a document with no encryption, you automatically have kPDFDocumentPermissionsOwner status.
Requires Mac OS X 10.6.
(Read only property)
PDFDocumentMBS.Producer as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
PDFDocumentMBS.stringValue as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Convenience method. Returns a string representing the entire document (each page's string concatenated with line feeds between pages).
If you need to extract the text of a PDF document cross platform or with more options, you may want to look on the DynaPDF plugin.
It seems like this string value is not always available. It works for PDF Documents created from a disc file, but not for files our test app created on runtime in memory by using PDFDocument constructor and insertpage.
(Read only property)
PDFDocumentMBS.Subject as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
PDFDocumentMBS.Title as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
The items on this page are in the following plugins: MBS PDFKit Plugin.