PDFViewControlMBS.AfterDrawPage(graphics as NSGraphicsMBS, page as PDFPageMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The draw event called after something was drawn.

On macOS 10.12.2 or later, this event is called on a non-main thread. In that case the plugin will not call this event.

PDFViewControlMBS.AfterDrawPagePost(graphics as NSGraphicsMBS, page as PDFPageMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The draw event called after a page annotations were drawn.

On macOS 10.12.2 or later, this event is called on a non-main thread. In that case the plugin will not call this event.

PDFViewControlMBS.AfterDrawRect(graphics as NSGraphicsMBS, x as Double, y as Double, w as Double, h as Double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The draw event called after a page was drawn.

On macOS 10.12.2 or later, this event is called on a non-main thread. In that case the plugin will not call this event.

PDFViewControlMBS.BeforeDrawPage(graphics as NSGraphicsMBS, page as PDFPageMBS) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The draw event called before a page was drawn.

On macOS 10.12.2 or later, this event is called on a non-main thread. In that case the plugin will not call this event.

PDFViewControlMBS.BeforeDrawPagePost(graphics as NSGraphicsMBS, page as PDFPageMBS) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The draw event called before a page annotations were drawn.

On macOS 10.12.2 or later, this event is called on a non-main thread. In that case the plugin will not call this event.

PDFViewControlMBS.BeforeDrawRect(graphics as NSGraphicsMBS, x as Double, y as Double, w as Double, h as Double) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The draw event called before a something was drawn.

PDFViewControlMBS.BoundsChanged

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The event called when the bounds, but not the frame, changed.

PDFViewControlMBS.Close

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The control is about to close.
In Xojo version 2021r3 and newer this event is named Closing.

PDFViewControlMBS.Closing

Type	Topic	Version
event	PDFKit	13.4

The control is about to close.
In older Xojo versions, this event is named Close.

PDFViewControlMBS.CocoaMouseDown(e as NSEventMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	21.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The mouse button was pressed inside the control’s region at the location passed in to x, y.

This is called before MouseDown, but provides the original Cocoa event, so you can query additional properties.

PDFViewControlMBS.CocoaMouseDrag(e as NSEventMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	21.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

This event fires continuously after the mouse button was pressed inside the Control.

This is called before MouseDrag, but provides the original Cocoa event, so you can query additional properties.

PDFViewControlMBS.CocoaMouseUp(e as NSEventMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	21.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The mouse button was released.

This is called before MouseUp, but provides the original Cocoa event, so you can query additional properties.

PDFViewControlMBS.ConstructContextualMenu(base as MenuItem, x as Integer, y as Integer) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	22.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

This event is called when it is appropriate to display a contextual menu for the control.

PDFViewControlMBS.ContextualMenuAction(hitItem as MenuItem) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Called when a menuitem is choosen.

This allows the control to react on its relevant menu items. Please return true if you handled it or false to give others a chance.

PDFViewControlMBS.didCloseContextualMenu(menu as NSMenuMBS, NSEvent as NSEventMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	24.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Did close contextual menu.

Allows you to restart any animation you may have stopped in the willShowContextualMenu event.

PDFViewControlMBS.EnableMenuItems

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The event where you can enable menu items.
In Xojo version 2021r3 and newer this event is named MenuBarSelected.

PDFViewControlMBS.FocusLost

Type	Topic	Version
event	PDFKit	16.5

The control lost focus.
In older Xojo versions, this event is named LostFocus.

This only fires if the control itself lost focus and not a sub control.

PDFViewControlMBS.FocusReceived

Type	Topic	Version
event	PDFKit	16.5

The control itself got focus.
In older Xojo versions, this event is named GotFocus.

This only fires if the control itself got focus and not a sub control.

PDFViewControlMBS.FrameChanged

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The event called when the frame changed.

This event notifies you, that the control changed it's bounding frame, which is position and/or size.

PDFViewControlMBS.GotFocus

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	16.5	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The control itself got focus.
In Xojo version 2021r3 and newer this event is named FocusReceived.

This only fires if the control itself got focus and not a sub control.

PDFViewControlMBS.LostFocus

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	16.5	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The control lost focus.
In Xojo version 2021r3 and newer this event is named FocusLost.

This only fires if the control itself lost focus and not a sub control.

PDFViewControlMBS.MenuBarSelected

Type	Topic	Version
event	PDFKit	17.1

The event where you can enable menu items.
In older Xojo versions, this event is named EnableMenuItems.

PDFViewControlMBS.MouseDown(x as Integer, y as Integer, Modifiers as Integer) As Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The mouse button was pressed inside the control’s region at the location passed in to x, y.

The coordinates x and y are local to the control, i.e. they represent the position of the mouse click relative to the upper-left corner or the Control.
Return True if you are going to handle the MouseDown. In such a case:

• The Action event, if any, will not execute and the state of the object will not change.
• You will receive the MouseDrag and MouseUp events.

If you return False, the system handles the MouseDown so the above event handlers do not get called.

PDFViewControlMBS.MouseDrag(x as Integer, y as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

This event fires continuously after the mouse button was pressed inside the Control.

Mouse location is local to the control passed in to x, y.
As this event is fired continuously (hundreds of time per second), it is your responsibility to determine if the mouse has really moved.

PDFViewControlMBS.MouseUp(x as Integer, y as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The mouse button was released.

Use the x and y parameters to determine if the mouse button was released within the control's boundaries.

PDFViewControlMBS.Open

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The control is about to was created and you can initialize it.
In Xojo version 2021r3 and newer this event is named Opening.

PDFViewControlMBS.Opening

Type	Topic	Version
event	PDFKit	13.4

The control is about to was created and you can initialize it.
In older Xojo versions, this event is named Open.

PDFViewControlMBS.OpenPDFforRemoteGoToAction(action as PDFActionRemoteGoToMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	21.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Opens a specified page.

This event will be called to handle clicks on annotations containing a PDFActionRemoteGoToMBS action. The action contains a URL and a page index and point. You should open the PDF indicated by the URL and go to the page and point indicated. The easiest way to do the latter is to create a PDFDestinationMBS with the page index and point once a PDFDocumentMBS from the URL is created - then you can call: goToDestination method. The default implementation simply beeps.

PDFViewControlMBS.PerformFind

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	21.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Performs a find operation.

Certain PDFAction's may request that the PDF viewer application perform a Find.
The event will be called when the user clicks on an annotation with such an action.

PDFViewControlMBS.PerformGoToPage

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	21.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Performs a go-to operation.

Certain PDFAction's may request that the PDF viewer application bring up a panel allowing the user to enter a specific page number. The event will be called when the user clicks on an annotation with such an action.

PDFViewControlMBS.PerformPrint

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	21.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Prints the current document.

Certain PDFAction's may request that the PDF viewer application Print the current document. This event will be called when the user clicks on an annotation with such an action.

PDFViewControlMBS.PrintJobTitle as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	21.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Overrides the job title used when the PDFView is printed.

Allows to override the job title when PDFView is printed. The default implementation uses the string, if any, associated with the "Title" key from the view's PDFDocumentMBS attribute dictionary. Failing that, it uses the last path component if the PDFDocumentMBS is URL-based.

PDFViewControlMBS.ScaleFactorChanged(NewFactor as Double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The backing store scale factor has changed.

Please invalidate any cached bitmaps or other relevant state.

PDFViewControlMBS.WillChangeScaleFactor(scale as Double) as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	21.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Overrides changes to the scale factor.

Allows to override changes to the scale factor. The default implementation pins scaling between 0.1 and 10.0.

If you add this event, please return a value, e.g. the passed scale value.

PDFViewControlMBS.WillClickOnLink(URL as String)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	21.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Handle clicks on URL links in a view.

If implemented, this event will be called to handle clicks on URL links within the PDFView.
The default implementation calls openURL on NSWorkspaceMBS class.

PDFViewControlMBS.willShowContextualMenu(menu as NSMenuMBS, NSEvent as NSEventMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	PDFKit	MBS PDFKit Plugin	24.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Will show contextual menu.

Your chance to modify the menu before it is shown, e.g. to add menu entries.