Monkeybread Xojo plugin - PDFDocumentMBS class

Platforms to show: All Mac Windows Linux Cross-Platform

PDFDocumentMBS class

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
class	PDFKit	MBS MacControls Plugin	8.0	✅ Yes	❌ No	❌ No	❌ No	Desktop, Console & Web

Function: The PDFKit class for a PDF document.
Notes:
Basicly this is the code used by Preview.app by Apple.

Destructor is dispatched to main thread to avoid bugs in OS X 10.12.

29 properties
- property allowsCommenting as Boolean
- property allowsContentAccessibility as Boolean
- property allowsCopying as boolean
- property allowsDocumentAssembly as Boolean
- property allowsDocumentChanges as Boolean
- property allowsFormFieldEntry as Boolean
- property allowsPrinting as boolean
- property Author as string
- property CreationDate as Date
- property CreationDateTime as DateTime
- property Creator as string
- property documentRef as Integer
- property documentURL as string
- property Handle as Integer
- property isEncrypted as boolean
- property isFinding as boolean
- property isLocked as boolean
- property majorVersion as Integer
- property minorVersion as Integer
- property ModificationDate as Date
- property ModificationDateTime as DateTime
- property outlineRoot as PDFOutlineMBS
- property pageCount as Integer
- property permissionsStatus as Integer
- property Producer as string
- property stringValue as string
- property Subject as string
- property Title as string
- property documentAttributes as Dictionary
29 methods
- method appendPage(page as PDFPageMBS)
- method beginFindString(text as string, options as Integer)
- method beginFindStrings(texts() as string, options as integer)
- method cancelFindString
- method Constructor
- method Constructor(data as memoryblock)
- method Constructor(data as String)
- method Constructor(file as folderitem)
- method Constructor(Handle as Integer)
- method copy as PDFDocumentMBS
- method dataRepresentation(QuartzFilter as Variant = nil) as memoryblock
- method exchangePageAtIndexWithPageAtIndex(indexA as Integer, indexB as Integer)
- method findString(text as string, options as Integer) as PDFSelectionMBS()
- method findStringFromSelection(text as string, selection as PDFSelectionMBS, options as Integer) as PDFSelectionMBS
- method indexForPage(page as PDFPageMBS) as Integer
- method insertPage(page as PDFPageMBS, index as Integer)
- method Keywords as string()
- method outlineItemForSelection(selection as PDFSelectionMBS) as PDFOutlineMBS
- method pageAtIndex(index as Integer) as PDFPageMBS
- method PrintOperation(PrintInfo as Variant, AutoRotate as boolean = true, scalingMode as Integer = 0) as Variant
- method removePageAtIndex(index as Integer)
- method selectionForEntireDocument as PDFSelectionMBS
- method selectionFromPage(StartPage as PDFPageMBS, StartCharacterIndex as Integer, EndPage as PDFPageMBS, EndCharacterIndex as Integer) as PDFSelectionMBS
- method selectionFromPage(StartPage as PDFPageMBS, StartPointX as single, StartPointY as single, EndPage as PDFPageMBS, EndPointX as single, EndPointY as single) as PDFSelectionMBS
- method SetDelegate(d as PDFDocumentDelegateMBS)
- method SetKeywords(keywords() as string)
- method unlockWithPassword(password as string) as boolean
- method write(file as folderitem, QuartzFilter as Variant = nil) as boolean
- method writeWithOptions(file as folderitem, options as dictionary) as boolean
20 shared methods
- shared method PDFDocumentAuthorAttribute as String
- shared method PDFDocumentCreationDateAttribute as String
- shared method PDFDocumentCreatorAttribute as String
- shared method PDFDocumentDidBeginFindNotification as String
- shared method PDFDocumentDidBeginPageFindNotification as String
- shared method PDFDocumentDidBeginPageWriteNotification as String
- shared method PDFDocumentDidBeginWriteNotification as String
- shared method PDFDocumentDidEndFindNotification as String
- shared method PDFDocumentDidEndPageFindNotification as String
- shared method PDFDocumentDidEndPageWriteNotification as String
- shared method PDFDocumentDidEndWriteNotification as String
- shared method PDFDocumentDidFindMatchNotification as String
- shared method PDFDocumentDidUnlockNotification as String
- shared method PDFDocumentKeywordsAttribute as String
- shared method PDFDocumentModificationDateAttribute as String
- shared method PDFDocumentOwnerPasswordOption as String
- shared method PDFDocumentProducerAttribute as String
- shared method PDFDocumentSubjectAttribute as String
- shared method PDFDocumentTitleAttribute as String
- shared method PDFDocumentUserPasswordOption as String
9 constants

Document Permissions

Constant	Value	Description
kPDFDocumentPermissionsNone	0	Document permissions status. For encrypted PDF's, supplying the owner password will enable owner permission status.
kPDFDocumentPermissionsOwner	2
kPDFDocumentPermissionsUser	1

Page Scaling Modes

Constant	Value	Description
kPDFPrintPageScaleDownToFit	2
kPDFPrintPageScaleNone	0
kPDFPrintPageScaleToFit	1

Search Flags

Constant	Value	Description
NSBackwardsSearch	4	Performs searching from the end of the range toward the beginning.
NSCaseInsensitiveSearch	1	Ignores case distinctions among characters.
NSLiteralSearch	2	Performs a byte-for-byte comparison. Differing literal sequences (such as composed character sequences) that would otherwise be considered equivalent are considered not to match. Using this option can speed some operations dramatically.

This class has no sub classes.

Some methods using this class:

PDFSelectionMBS.Constructor(doc as PDFDocumentMBS)

Some properties using for this class:

PDFOutlineMBS.document as PDFDocumentMBS
PDFPageMBS.document as PDFDocumentMBS
PDFViewMBS.document as PDFDocumentMBS

Some examples using this class:

Blog Entries

Xojo Developer Magazine

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

PDFDocumentDelegateMBS - PDFOutlineMBS

💬 Ask a question or report a problem