Combo Box Events

Not supported by TWC

Event icon The Combo Box supports the following scripting events. Click next to any event name in the Events pane to see a short description for the selected event.

See Accessing Screen Objects for more information about how to view control objects in script in the Canvas application.

When an event is enabled, the control will be automatically added to script and the Include in script property will be set to True.

Event Description

Close

The Close event is called when the screen is closed.

Initialize

The Initialize event is called when the screen is created in preview or run mode to allow further initialization of the control.

Loaded

The Loaded event is called when the control is rendered and ready for interaction.

Mouse Enter

The Mouse Enter event is called when the mouse pointer enters (moves over) a control.

Mouse Leave

The Mouse Leave event is called when the mouse pointer leaves (moves out of) a control.

Selection Changed

The Selection Changed event is called when the selection in the control changes or a new element is clicked.

Examples

Copy
Selection Changed event for Heat Map
var argument = args as Canvas.Controls.HeatMap.CanvasHeatMapSelectionChangedEventArgs;

 

Copy
Selection Changed event for Tree Map
var argument = args as Canvas.Controls.TreeMap.CanvasTreeMapSelectionChangedEventArgs;

See Event Argument Type for more information about EventArgs.

The script property, SelectedItem, can be used with the Selection Changed event to return additional information about the item selected in the Combo Box.

See Order of Event Execution for information about the order in which events are executed on a screen.