===== Button =====

com.ergotech.vib.graphics.Button

==== Image Examples ====

| {{:mistudio:graphics:basic_layout:active_controls:pasted:20260622-142920.gif?50|Button in the graphics palette}} | {{:mistudio:graphics:active_controls:pasted:20260619-182228.png?100|Button graphic example}} |
| //Button in the graphics palette.// | //Button graphic example.// |

==== Overview ====

The Button graphic is an Active Control used to send an output value when the user interacts with it.

A Button is commonly used as an on/off control. It can toggle between an off state and an on state, and it can send a new output value when the state changes.

Button shares many common properties with other button-style controls. See [[mistudio:design_editor:basic_layout:active_controls:button_style_common_properties|Button-Style Control Common Properties]] for shared label, color, image, value, bezel, quality indicator, enabled, rotation, and visibility properties.

==== Common Uses ====

  * Creating an on/off control
  * Sending a boolean-style value
  * Triggering application logic
  * Updating another graphic or control
  * Displaying one of two button states
  * Displaying different labels or images for on and off states

==== Input Behavior ====

The Button has the regular input behavior of an [[mistudio:design_editor:active_control_common_properties|Active Control]].

The Button display can be updated from an input connection. This can be useful when the Button needs to show a state from another source.

==== Output Behavior ====

The Button sends an output value when its state changes.

In a typical on/off setup, the off state sends the configured **Value for Off**, and the on state sends the configured **Value for On**.

By default, these values are commonly set to 0 for off and 1 for on.

==== Button-Specific Behavior ====

The Button includes a **Trigger Type** property that controls how the Button output behaves when the user interacts with it.

==== Trigger Types ====

**Toggle** The Button switches between off and on each time it is pressed.

**Pressed** The Button stays active while it is being pressed and returns to the off state when released.

**Timed** The Button stays active for a configured amount of time, then returns to the off state.

**Trigger** The Button sends the active value each time it is pressed.

==== Notes ====

For shared active control behavior, see [[mistudio:design_editor:active_control_common_properties|Active Control Common Properties]].

For shared Button, PushButton, and URLButton settings, see [[mistudio:design_editor:basic_layout:active_controls:button_style_common_properties|Button-Style Control Common Properties]].

==== Related Pages ====

  * [[mistudio:design_editor:start|MIStudio Design Editor]]
  * [[mistudio:design_editor:basic_layout:start|Basic Layout]]
  * [[mistudio:design_editor:basic_layout:active_controls:start|Active Controls]]
  * [[mistudio:design_editor:active_control_common_properties|Active Control Common Properties]]
  * [[mistudio:design_editor:basic_layout:active_controls:button_style_common_properties|Button-Style Control Common Properties]]
  * [[mistudio:design_editor:basic_layout:active_controls:pushbutton|PushButton]]
  * [[mistudio:design_editor:basic_layout:active_controls:urlbutton|URLButton]]
  * [[mistudio:design_editor:active_graphic|Active Graphic]]