---
title: "Vision - Button"
description: "The Button component can be configured to open and/or close windows, write to tags, and run scripts when triggered by an event handler."
---

# Vision - Button

> The Button component can be configured to open and/or close windows, write to tags, and run scripts when triggered by an event handler.

![](button.png)

**Component Palette Icon**:

![](button3.png)

## Properties
| Property 	| Description 	| Property Type 	| Scripting 	| Category 	|
|---	|---	|---	|---	|---	|
| Background Color 	| The background color of the button. Can be chosen from color wheel, chosen from color palette, or entered as  RGB  or  HSL  value. See [Color Selector](appendix/reference-pages/color-selector-reference/color-selector-reference.mdx). 	| Color 	| .buttonBG 	| Appearance 	|
| Border 	| The border surrounding this component. No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Field Border, and Line Border.**Note**: The border is unaffected by rotation. 	| Border 	| .border 	| Common 	|
| Cursor 	| The mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize. 	| int 	| .cursorCode 	| Common 	|
| Default Button 	| If true, this button will be activated when the user presses Enter on the window. 	| boolean 	| .defaultBtn 	| Behavior 	|
| Disabled Image Path 	| The relative path of the image to be displayed when this component is not enabled. 	| String 	| .disabledPath 	| Appearance 	|
| Enabled 	| If disabled, a component cannot be used. 	| boolean 	| .componentEnabled 	| Common 	|
| Fill Area? 	| Controls whether or not this button's internal area is filled. 	| boolean 	| .contentAreaFilled 	| Appearance 	|
| 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. 	| boolean 	| .focusable 	| Behavior 	|
| Font 	| Font of text on this component. 	| Font 	| .font 	| Appearance 	|
| Foreground Color 	| The foreground color of the component. See [Color Selector](appendix/reference-pages/color-selector-reference/color-selector-reference.mdx). 	| Color 	| .foreground 	| Appearance 	|
| Horizontal Alignment 	| The horizontal alignment of the button's contents (text and/or image). 	| int 	| .horizontalAlignment 	| Layout 	|
| Horizontal Text Position 	| The horizontal position of the button's text relative to its image. 	| int 	| .horizontalTextPosition 	| Layout 	|
| Icon-Text Spacing 	| The space (in pixels) between the icon (if any) and the text (if any). 	| int 	| .iconTextGap 	| Appearance 	|
| Image Path 	| The relative path of the image. 	| String 	| .path 	| Appearance 	|
| Margin 	| The space between a button's text and its borders. 	| Insets 	| .margin 	| Layout 	|
| Mnemonic 	| A single letter that will activate the button using 'ALT-mnemonic'. 	| String 	| .mnemonicChar 	| Behavior 	|
| Mouseover Text 	| The text that is displayed in the tooltip which pops up on mouseover of this component. 	| String 	| .toolTipText 	| Common 	|
| Name 	| The name of this component. 	| String 	| .name 	| Common 	|
| Quality 	| The data quality code for any bindings on this component. 	| QualityCode 	| .quality 	| Data 	|
| Rollover 	| If true, the button may indicate that the mouse is hovering over it. 	| boolean 	| .rolloverEnabled 	| Behavior 	|
| Styles 	| Contains the component's styles. 	| Dataset 	| .styles 	| Appearance 	|
| Text 	| Text of this component. 	| String 	| .text 	| Appearance 	|
| Vertical Alignment 	| The vertical alignment of the button's contents (text and/or image). 	| int 	| .verticalAlignment 	| Layout 	|
| Vertical Text Position 	| The vertical position of the button's text relative to its image. 	| int 	| .verticalTextPosition 	| Layout 	|
| Visible 	| If disabled, the component will be hidden. 	| boolean 	| .visible 	| Common 	|

### Deprecated Properties
| Property 	| Description 	| Property Type 	| Scripting 	| Category 	|
|---	|---	|---	|---	|---	|
| Data Quality 	| The data quality code for any tag bindings on this component. 	| int 	| .dataQuality 	| Data 	|
| Opaque 	| If true, button will be opaque. Default is false.	| boolean 	| .opaque 	| Common 	|

## Scripting
See the [Vision - Button Scripting Functions](button-scripting.md) page for the full list of scripting functions available for this component.

### Event Handlers
Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the [Component Events](ignition-modules/vision/scripting-in-vision/component-events/component-events.md) page

## Customizers
+ [Vision Component Customizers](ignition-modules/vision/working-with-vision-components/vision-component-customizer/vision-component-customizer.md)
+ [Style Customizer](ignition-modules/vision/working-with-vision-components/vision-component-customizer/vision-component-customizer.md#style-customizer)

## Examples

### Styled Button
![](button-example1.png)

|Property Name|Value|
|:---|:---|
|Border|Etched (Raised)|
|Font|Dialog, Bold, 18|
|Text|Press Me!|
|Image Path|Builtin/icons/48/check2.png|

### Styled Button
![](button-example2.png)

|Property Name|Value|
|:---|:---|
|Border|No Border|
|Fill Area?|False|
|Border Painted?|False|
|Text|None|
|Image Path|Builtin/icons/48/stop.png|