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
Indicate whether dragging a file into PDFView is allowed.

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
Determines whether the view can accept new PDF documents dragged into it by the user.

(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
A Boolean value indicating whether autoscaling is set.

(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
Returns the view's background color.

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.canGoBack as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a Boolean value indicating whether the user can navigate to the previous page in the page history.

The page history gets built as your application calls navigation methods such as goToDestination and goToLastPage.
(Read only property)

PDFViewMBS.canGoForward as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a Boolean value indicating whether the user can navigate to the next page in the page history.

The page history gets built as your application calls navigation methods such as goToDestination and goToLastPage.
(Read only property)

PDFViewMBS.canGoToFirstPage as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a Boolean value indicating whether the user can navigate to the first page of the document.

The return value will be true unless the view is already displaying the first page.
(Read only property)

PDFViewMBS.canGoToLastPage as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a Boolean value indicating whether the user can navigate to the last page of the document.

The return value will be true unless the view is already displaying the last page.
(Read only property)

PDFViewMBS.canGoToNextPage as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a Boolean value indicating whether the user can navigate to the next page of the document.

The return value will be true unless the view is displaying the last page.
(Read only property)

PDFViewMBS.canGoToPreviousPage as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a Boolean value indicating whether the user can navigate to the previous page of the document.

The return value will be true unless the view is displaying the first page.
(Read only property)

PDFViewMBS.canZoomIn as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a Boolean value indicating whether the user can magnify the view—that is, zoom in.

(Read only property)

PDFViewMBS.canZoomOut as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a Boolean value indicating whether the user can view an expanded area—that is, zoom out.

(Read only property)

PDFViewMBS.currentDestination as PDFDestinationMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a PDFDestination object representing the current page and the current point in the view specified in page space.

Page space is a 72 dpi coordinate system with the origin at the lower-left corner of the current page.
(Read only property)

PDFViewMBS.currentPage as PDFPageMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns the current page.

When there are two pages in the view in a two-up mode, "current page" is the left page. For continuous modes, returns the page crossing a horizontal line halfway between the view's top and bottom bounds.
(Read only property)

PDFViewMBS.currentSelection as PDFSelectionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns the current selection.
Example
dim MyPDFView as PDFViewMBS // your view

dim doc as PDFDocumentMBS = MyPDFView.document
dim page as PDFPageMBS = doc.pageAtIndex(0)
dim sel as PDFSelectionMBS = page.selectionForRange(0,5)
MyPDFView.currentSelection = sel

Returns NULL if no selection exists.

Note that this method returns the actual instance of the current PDFSelectionMBS object. Therefore, if you want to modify it, you should make a copy of the returned selection and modify that, instead.
(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 current style of display box.

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
Set the layout direction, either vertical or horizontal, for the given display mode.

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
The current display mode.

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
A Boolean value indicating whether the view will display the first page as a book cover (meaningful only when the document is in two-up or two-up continuous display mode).

(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
A Boolean value indicating whether the view is displaying page breaks.

(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
Specifies presentation of pages from right-to-left.

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
Returns the document associated with a PDFView object.

(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
Returns the innermost view used by PDFView or by your PDFView subclass.

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
Whether data detection is enabled.

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 greeking threshold to use for displaying text.

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
The interpolation quality for images drawn into the PDFView context.

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
Set the maximum scaling factor for the PDF document.

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
Set the minimum scaling factor for the PDF document.

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
The page break margins.

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
Specifies if shadows should be drawn around page borders in a PDFView.

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 scale factor for the view.

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
Regardless of current autoScales mode, this returns the "size to fit" scale factor that autoScales would use for scaling the current document and layout.

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
Whether to use anti-aliasing in the view.

(Read and Write property)

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


The biggest plugin in space...