You're currently browsing the Ignition 7.8 docs. Click here to view the latest docs.

General

Component Palette Icon:



Description

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 then released, its 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.

Properties

Scripting
Scripting Functions

This component does not have scripting functions associated with it.

Extension Functions

This component does not have scripting functions associated with it.

Event Handlers

An integer that indicates whether the state was changed to "Selected" (on) or "Deselected" (off). Compare this to the event object's constants to determine what the new state is.

Fires when a key is released and the source component has the input focus. Works for all characters, including non-printable ones, such as SHIFT and F3.

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

This event fires when the mouse enters the space over the source component.

This event fires when the mouse leaves the space over the source component.

This event fires when a mouse button is pressed down on the source component.

This event fires when a mouse button is released, if that mouse button's press happened over this component.

Fires when the mouse moves over a component after a button has been pushed.

Fires when the mouse moves over a component, but no buttons are pushed.

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

Customizers

The multi-state button customizer provides a way to edit the states dataset in the component's property.

Examples
Stylized Multi-State Button

Property NameValue
Display StyleGrid
Styles
  • No labels