ButtonMBS.Action(x as Integer, y as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Controls	MBS Overlay Plugin	8.4	✅ Yes	✅ Yes	✅ Yes	❌ No

The event called when the mouse button is clicked in the control.

Currently called after each MouseUp event.

ButtonMBS.Close

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Controls	MBS Overlay Plugin	8.4	✅ Yes	✅ Yes	✅ Yes	❌ No

The control is about to close.

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Controls	MBS Overlay Plugin	22.1	✅ Yes	✅ Yes	✅ Yes	❌ No

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

ButtonMBS.ContextualMenuAction(hitItem as MenuItem) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Controls	MBS Overlay Plugin	17.1	✅ Yes	✅ Yes	✅ Yes	❌ No

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.

ButtonMBS.EnableMenuItems

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Controls	MBS Overlay Plugin	17.1	✅ Yes	✅ Yes	✅ Yes	❌ No

The event where you can enable menu items.

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Controls	MBS Overlay Plugin	17.1	✅ Yes	✅ Yes	✅ Yes	❌ 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.

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Controls	MBS Overlay Plugin	8.4	✅ Yes	✅ Yes	✅ Yes	❌ No

The mouse drag event.

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Controls	MBS Overlay Plugin	8.4	✅ Yes	✅ Yes	✅ Yes	❌ No

The event called when the mouse button is released.

ButtonMBS.Open

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Controls	MBS Overlay Plugin	8.4	✅ Yes	✅ Yes	✅ Yes	❌ No

The control is about to was created and you can initialize it.

ButtonMBS.ScaleFactorChanged(NewFactor as Double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Controls	MBS Overlay Plugin	17.1	✅ Yes	✅ Yes	✅ Yes	❌ No

The backing store scale factor has changed.

Please invalidate any cached bitmaps or other relevant state.