---
title: "Check Box"
description: "A CheckBox is a familiar component that represents a bit - it is either on (selected) or off (not selected). It is functionally equivalent to the Toggle Button component."
---

# Check Box

> A CheckBox is a familiar component that represents a bit - it is either on (selected) or off (not selected). It is functionally equivalent to the Toggle Button component.

![](checkbox1.png)

**Component Palette Icon**

![](CheckBox2.png)

## Properties
|Name|Description|Property Type|Scripting|Category|
|:---|:---|:---|:---|:---|
|Antialias|Draw with antialias on? Makes text smoother.|boolean|.antialias|Appearance|
|Background Color|The background color of the component.|Color|.background|Appearance|
|Border|The border surrounding this component. NOTE that the border is unaffected by rotation.|Border|.border|Common|
|Cursor|The mouse cursor to use when hovering over this component.|int|.cursorCode|Common|
|Data Quality|The data quality code for any tag bindings on this component.|int|.dataQuality|Data|
|Enabled|If disabled, a component cannot be used.|boolean|.componentEnabled|Common|
|Fill Background|If true, the label's background color will be drawn. If false, it will have a transparent background.|boolean|.fillBackground|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.|Color|.foreground|Appearance|
|Horizontal Alignment|The horizontal alignment of the button's contents (text and/or image).|int|.horizontalAlignment|Layout|
|Margin|The internal margin that provides padding for the contents of this button.|Insets|.margin|Appearance|
|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|
|Rollover|If true, the button may indicate that the mouse is hovering over it.|boolean|.rolloverEnabled|Behavior|
|Selected|The current state of the checkbox.|boolean|.selected|Data|
|Styles|Contains the component's styles.|Dataset|.styles|Appearance|
|Text|The text displayed on the checkbox.|String|.text|Appearance|
|Vertical Alignment|The vertical alignment of the button's contents (text and/or image).|int|.verticalAlignment|Layout|
|Visible|If disabled, the component will be hidden.|boolean|.visible|Common|

## Scripting

### Scripting Functions
This component does not have scripting functions associated with it.

### 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](scripting\scripting-in-ignition\component-and-window-scripting\component-events.md) page

## Customizers
+ [Vision Component Customizers](visualization-and-dashboards\understanding-components\component-customizers\component-customizers.md)
+ [Style Customizer](visualization-and-dashboards\understanding-components\component-customizers\component-customizers.md#style-customizer)

## Examples
![](checkbox.png)