Multi-State Button

This button is really a series of two or more buttons, arranged in a column, row, or grid. Each button represents an integer-valued state. Each state defines two styles for a button: the selected style, and the unselected style. Each button is automatically displayed with the correct style based on the current state (the value of Indicator Value). When a button is pressed, it's state's value is written to the Control Value.

To configure a Multi-State Button, simply drag a tag that represents your state onto the Multi-State Button. This will bind both the Control Value and Indicator Value to that tag. Now open up the Multi-State Button customizer, and define your states: their order, values and styles. Lastly choose if you want the buttons to be a column, row, or grid by setting the Display Style property.

Appearance

Font

Font of text of this component

Scripting name	font
Data type	Font

Display Style

The display style (rows or columns) for this N-state button.

Scripting name

displayStyle

Data type

int

Values

0	Column
1	Row
2	Grid

Horizontal Gap

The horizontal spacing between buttons

Scripting name	hGap
Data type	int

Vertical Gap

The vertical spacing between buttons

Scripting name	vGap
Data type	int

Grid Rows

The number of rows if the Display Style is set to "Grid" mode.

Scripting name	gridRows
Data type	int

Grid Cols

The number of columns if the Display Style is set to "Grid" mode.

Scripting name	gridCols
Data type	int

Background 3D?

Controls whether or not the buttons have a gradient-style background color.

Scripting name	background3D
Data type	boolean
Flags	expert

Behavior

Confirm?

If true, a confirmation box will be shown.

Scripting name	confirm
Data type	boolean

Confirm Text

The message to ask the user if confirmation is turned on.

Scripting name	confirmText
Data type	String

States

A Dataset that stores the information for the different states.

Scripting name	states
Data type	Dataset
Flags	expert

Rollover

If true, the button may indicate that the mouse is hovering over it.

Scripting name	rolloverEnabled
Data type	boolean
Flags	expert

Focusable

If a button is not focusable, you will not be able to interact with it with the keyboard. This means you can't "tab" over to it.

Scripting name	focusableEnabled
Data type	boolean
Flags	expert

Common

Name

The name of this component.

Scripting name	name
Data type	String
Flags	bindable

Enabled

If disabled, a component cannot be used.

Scripting name	enabled
Data type	boolean

Visible

If disabled, the component will be hidden.

Scripting name	visible
Data type	boolean

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

Scripting name	toolTipText
Data type	String

Cursor

The mouse cursor to use when hovering over this component.

Scripting name

cursorCode

Data type

int

Values

0	Default
1	Crosshair
2	Text
3	Wait
12	Hand
13	Move
4	SW Resize
5	SE Resize
6	NW Resize
7	NE Resize
8	N Resize
9	S Resize
10	W Resize
11	E Resize

Data

Control Value

Bind this to the tag that controls the state. (Typically, this is bound to the same location as Indicator Value)

Scripting name	controlValue
Data type	int
Flags	bindable

Indicator Value

Bind this to the tag that indicates the current state. (Typically, this is bound to the same location as Control Value)

Scripting name	indicatorValue
Data type	int
Flags	bindable

Data Quality

The data quality code for any tag bindings on this component.

Scripting name	dataQuality
Data type	int
Flags	bindable \| expert

The following event sets are fired by this component. See Component Event Handlers to learn more.