Platforms to show: All Mac Windows Linux Cross-Platform
Back to PDFViewMBS class.
PDFViewMBS.acceptsDraggedFiles as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
If false (default), dragging events are not supported.
If true, a user can drag and drop a PDF file into the view and have it loaded & set as the visible document (the old document is released).
Available in macOS 10.13 or newer.
(Read and Write property)
PDFViewMBS.allowsDragging as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read and Write property)
PDFViewMBS.autoScales as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
(Read and Write property)
Some examples using this property:
PDFViewMBS.backgroundColor as NSColorMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
A view's background is the area displayed to either side of a PDF document's pages. The background also appears between pages when page breaks are enabled. The default color is a 50% gray.
(Read and Write property)
PDFViewMBS.displayBox as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
The available values for display boxes are defined in the Constants section in the PDFPageMBS class.
(Read and Write property)
PDFViewMBS.displayDirection as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
Defaults to vertical layout (kPDFDisplayDirectionVertical).
Available in macOS 10.13 or newer.
(Read and Write property)
PDFViewMBS.displayMode as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
Value can be kPDFDisplaySinglePage, kPDFDisplaySinglePageContinuous, kPDFDisplayTwoUp and kPDFDisplayTwoUpContinuous.
(Read and Write property)
PDFViewMBS.displaysAsBook as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
(Read and Write property)
PDFViewMBS.displaysPageBreaks as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
(Read and Write property)
Some examples using this property:
PDFViewMBS.displaysRTL as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
Defaults to false.
(Read and Write property)
PDFViewMBS.document as PDFDocumentMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
(Read and Write property)
PDFViewMBS.documentView as NSViewMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
The innermost view is the one displaying the visible document pages. This method is useful when converting coordinates from one view to another.
(Read only property)
PDFViewMBS.enableDataDetectors as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
If enabled, page text will be scanned for URL's as the page becomes visible. Where
// URL's are found, Link annotations are created in place. These are temporary annotations and are not saved.
Requires Mac OS X 10.6.
(Read and Write property)
PDFViewMBS.greekingThreshold as Double
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The default threshold is 3.0.
(Read and Write property)
PDFViewMBS.interpolationQuality as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
Available in Mac OS X 10.7 or later.
(Read and Write property)
PDFViewMBS.maxScaleFactor as Double
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
Assigning this value will implicitly turn off autoScales, and allows scaleFactor to vary between these min / max scale factors
Available in macOS 10.13 or newer.
(Read and Write property)
PDFViewMBS.minScaleFactor as Double
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
Assigning this value will implicitly turn off autoScales, and allows scaleFactor to vary between these min / max scale factors
Available in macOS 10.13 or newer.
(Read and Write property)
PDFViewMBS.pageBreakMargins as NSEdgeInsetsMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
If displaysPageBreaks is enabled, you may customize the spacing between pages by defining margins for the top, bottom, left, and right of each page. Note that pageBreakMargins only allows positive values and will clamp any negative value to 0.0. By default, if displaysPageBreaks is enabled, pageBreakMargins is { 4.75, 4.0, 4.75, 4.0 } (with respect to top, left, bottom, right), otherwise it is { 0.0, 0.0, 0.0, 0.0 }
(Read and Write property)
PDFViewMBS.pageShadowsEnabled as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
Defaults to true.
Available in macOS 10.14 or newer.
(Read and Write property)
PDFViewMBS.scaleFactor as Double
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
The default value is 1.0, corresponding to actual size.
(Read and Write property)
PDFViewMBS.scaleFactorForSizeToFit as Double
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | Desktop & iOS |
For continuous modes this is a "fit width" scale, for non-continuous modes it is a "best fit" scale.
Available in macOS 10.13 or newer.
(Read only property)
PDFViewMBS.shouldAntiAlias as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read and Write property)
The items on this page are in the following plugins: MBS PDFKit Plugin.