Platforms to show: All Mac Windows Linux Cross-Platform

PDFDocumentMBS.allowsCopying as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: Whether copying is allowed.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox str(doc.allowsCopying)
Notes:
Even unlocked, encrypted PDF's may have certain restrictions regarding copying or printing placed upon them.
(Read only property)

Feedback, Comments & Corrections

PDFDocumentMBS.allowsPrinting as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: Whether printing is allowed.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox str(doc.allowsPrinting)
Notes:
Even unlocked, encrypted PDF's may have certain restrictions regarding copying or printing placed upon them.
(Read only property)

Feedback, Comments & Corrections

PDFDocumentMBS.Author as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: String containing document author.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox doc.Author
Notes: (Read and Write property)

Feedback, Comments & Corrections

PDFDocumentMBS.CreationDate as Date
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: Date representing document creation date.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox doc.CreationDate.LongDate
Notes: (Read and Write property)

Feedback, Comments & Corrections

PDFDocumentMBS.Creator as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: String containing name of app that created document content.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox doc.Creator
Notes: (Read and Write property)

Feedback, Comments & Corrections

PDFDocumentMBS.documentURL as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: The document location.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox doc.documentURL
Notes:
May return nil if the document was created from data.
(Read only property)

Feedback, Comments & Corrections

PDFDocumentMBS.Handle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 10.4 Yes No No Yes, macOS only No
Function: The internal reference to the PDF Document.
Notes: (Read and Write property)

Feedback, Comments & Corrections

PDFDocumentMBS.isEncrypted as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: Whether the PDF is encrypted.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox str(doc.isEncrypted)
Notes:
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)

Feedback, Comments & Corrections

PDFDocumentMBS.isFinding as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: Returns true if document is currently searching for a string.
Notes: (Read only property)

Feedback, Comments & Corrections

PDFDocumentMBS.isLocked as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: Whether the PDF is locked.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox str(doc.isLocked)
Notes:
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)

Feedback, Comments & Corrections

PDFDocumentMBS.majorVersion as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: PDF version of the PDF file (example: major version = 1, minor = 4; PDF v1.4).
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox str(doc.majorVersion)+"."+str(Doc.minorVersion)
Notes: (Read only property)

Feedback, Comments & Corrections

PDFDocumentMBS.minorVersion as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: PDF version of the PDF file (example: major version = 1, minor = 4; PDF v1.4).
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox str(doc.majorVersion)+"."+str(Doc.minorVersion)
Notes: (Read only property)

Feedback, Comments & Corrections

PDFDocumentMBS.ModificationDate as Date
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: Date representing last document modification date.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox doc.ModificationDate.LongDate
Notes: (Read and Write property)

Feedback, Comments & Corrections

PDFDocumentMBS.outlineRoot as PDFOutlineMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: Returns the root outline object for the PDF (or nil if none).
Notes: (Read and Write property)

Feedback, Comments & Corrections

PDFDocumentMBS.pageCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: The number of pages in the document.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox str(Doc.pageCount)
Notes: (Read only property)

Feedback, Comments & Corrections

PDFDocumentMBS.permissionsStatus as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 9.6 Yes No No Yes, macOS only No
Function: Returns the permissions status of the PDF document.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)

Select case doc.permissionsStatus
case doc.kPDFDocumentPermissionsNone
MsgBox "None"
case doc.kPDFDocumentPermissionsOwner
MsgBox "Owner or no password"
case doc.kPDFDocumentPermissionsUser
MsgBox "User"
end Select
Notes:
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)

Feedback, Comments & Corrections

PDFDocumentMBS.Producer as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: String containing name of app that produced PDF data.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox doc.Producer
Notes: (Read and Write property)

Feedback, Comments & Corrections

PDFDocumentMBS.stringValue as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: The text of the document.
Example:
dim p as PDFDocumentMBS
dim f as FolderItem

f=SpecialFolder.Desktop.Child("test.pdf")
p=new PDFDocumentMBS(f)

MsgBox "Text from PDF Document:"+EndOfLine+EndOfLine+p.stringValue
Notes:
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)

Feedback, Comments & Corrections

PDFDocumentMBS.Subject as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: String containing document subject.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox doc.Subject
Notes: (Read and Write property)

Feedback, Comments & Corrections

PDFDocumentMBS.Title as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: String containing document title.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
MsgBox doc.Title
Notes: (Read and Write property)

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS MacControls Plugin.

The biggest plugin in space...




Links
MBS Xojo Plugins