DesktopIKScannerDeviceViewControlMBS.BoundsChanged

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	21.5	✅ Yes	❌ No	❌ No	❌ No

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

DesktopIKScannerDeviceViewControlMBS.Closing

Type	Topic	Version
event	Image Capture	21.5

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

DesktopIKScannerDeviceViewControlMBS.ConstructContextualMenu(base as DesktopMenuItem, x as Integer, y as Integer) As Boolean

Type	Topic	Version
event	Image Capture	22.1

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

DesktopIKScannerDeviceViewControlMBS.ContextualMenuItemSelected(selectedItem As DesktopMenuItem) As Boolean

Type	Topic	Version
event	Image Capture	21.5

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.

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	24.1	✅ Yes	❌ No	❌ No	❌ No

Did close contextual menu.

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

DesktopIKScannerDeviceViewControlMBS.DidEncounterError(error as NSErrorMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	21.5	✅ Yes	❌ No	❌ No	❌ No

This event is sent every time the scanner device reports an error.

DesktopIKScannerDeviceViewControlMBS.DidScanToBandData(data as ICScannerBandDataMBS, scanInfo as Dictionary, error as NSErrorMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	21.5	✅ Yes	❌ No	❌ No	❌ No

For memory a based transfer this event is sent for every time an image band of data was scanned.

The 'data' parameter describes the scanned image data. Note that rotation/cropping/image adjustments are not applied yet. The 'scanInfo' parameter contains additional information (rotation angle, ...) that should be applied once the scan is completed.

DesktopIKScannerDeviceViewControlMBS.DidScanToURL(url as String, file as FolderItem, fileData as MemoryBlock, error as NSErrorMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	21.5	✅ Yes	❌ No	❌ No	❌ No

For file based transfer this event is sent for each image that gets scanned.

Based on the IKScannerDeviceViewTransferMode the downloaded file will be saved on disk using the 'url', or returned in memory as Memoryblock.

DesktopIKScannerDeviceViewControlMBS.FocusLost

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	21.5	✅ Yes	❌ No	❌ No	❌ No

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.

DesktopIKScannerDeviceViewControlMBS.FocusReceived

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	21.5	✅ Yes	❌ No	❌ No	❌ No

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.

DesktopIKScannerDeviceViewControlMBS.FrameChanged

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	21.5	✅ Yes	❌ No	❌ No	❌ No

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.

DesktopIKScannerDeviceViewControlMBS.MenuBarSelected

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	21.5	✅ Yes	❌ No	❌ No	❌ No

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

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	21.5	✅ Yes	❌ No	❌ No	❌ No

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.

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	21.5	✅ Yes	❌ No	❌ No	❌ No

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.

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	21.5	✅ Yes	❌ No	❌ No	❌ No

The mouse button was released.

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

DesktopIKScannerDeviceViewControlMBS.Opening

Type	Topic	Version
event	Image Capture	21.5

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

DesktopIKScannerDeviceViewControlMBS.ScaleFactorChanged(NewFactor as Double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	21.5	✅ Yes	❌ No	❌ No	❌ No

The backing store scale factor has changed.

Please invalidate any cached bitmaps or other relevant state.

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Image Capture	MBS AVFoundation Plugin	24.1	✅ Yes	❌ No	❌ No	❌ No

Will show contextual menu.

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