---
id: "T:cAlgo.API.CheckBox"
kind: "class"
namespace: "cAlgo.API"
url: "https://help.ctrader.com/ctrader-algo/references/Controls/CheckBox/"
---

> Documentation index for agents: https://help.ctrader.com/ctrader-algo/llms.txt · machine index: https://help.ctrader.com/ctrader-algo/api.json

# CheckBox (class)

Represents the Checkbox.

Environments: Desktop supported · CLI not supported · Cloud not supported.

- CLI: Accepted without error but never displayed, so control events such as Click are never raised.
- Cloud: Accepted without error but never displayed, so control events such as Click are never raised.

## Definition

```csharp
public class CheckBox : Control
```

## Examples

C#:

```csharp
using cAlgo.API;

namespace cAlgo
{
    // This sample shows how to use checkbox control and handle its checked/unchecked events
    public partial class CheckBoxControlSample : Indicator
    {
        protected override void Initialize()
        {
            var stackPanel = new StackPanel
            {
                HorizontalAlignment = HorizontalAlignment.Center,
                VerticalAlignment = VerticalAlignment.Center,
                BackgroundColor = Color.Gold
            };

            var checkBox = new CheckBox
            {
                Text = "Unchecked",
                Margin = 10,
                FontWeight = FontWeight.ExtraBold
            };

            checkBox.Checked += CheckBox_Checked;
            checkBox.Unchecked += CheckBox_Unchecked;

            stackPanel.AddChild(checkBox);

            Chart.AddControl(stackPanel);
        }

        private void CheckBox_Unchecked(CheckBoxEventArgs obj)
        {
            obj.CheckBox.Text = "Unchecked";
        }

        private void CheckBox_Checked(CheckBoxEventArgs obj)
        {
            obj.CheckBox.Text = "Checked";
        }

        public override void Calculate(int index)
        {
        }
    }
}
```

Python:

```python
import clr
clr.AddReference("cAlgo.API")

from cAlgo.API import *

class Test():
    def initialize(self):
        stackPanel = StackPanel()
        stackPanel.HorizontalAlignment = HorizontalAlignment.Center
        stackPanel.VerticalAlignment = VerticalAlignment.Center
        stackPanel.BackgroundColor = Color.Gold

        checkBox = CheckBox()
        checkBox.Text = "Unchecked"
        checkBox.Margin = Thickness(10)
        checkBox.FontWeight = FontWeight.ExtraBold

        checkBox.Checked += self.on_checkBox_checked
        checkBox.Unchecked += self.on_checkBox_unchecked

        stackPanel.AddChild(checkBox)

        api.Chart.AddControl(stackPanel)

    def on_checkBox_checked(self, args):
        args.CheckBox.Text = "Checked"

    def on_checkBox_unchecked(self, args):
        args.CheckBox.Text = "Unchecked"
```

config.json:

```json
{
  "AccessRights": "None",
  "TimeZone": "UTC",
  "IsOverlay": true
}
```

## Constructors

- `public CheckBox()` — Initializes a new instance of the checkbox class. [details](https://help.ctrader.com/ctrader-algo/references/Controls/CheckBox/Constructor/index.md)

## Properties

- `public ControlBase Content {get; set;}` — Gets or sets the content. [details](https://help.ctrader.com/ctrader-algo/references/Controls/CheckBox/Content/index.md)
- `public bool? IsChecked {get; set;}` — Gets or sets a value indicating whether the checkbox is checked. [details](https://help.ctrader.com/ctrader-algo/references/Controls/CheckBox/IsChecked/index.md)
- `public bool IsThreeState {get; set;}` — Checks if the checkbox may be of three states - checked, unchecked and indeterminate. [details](https://help.ctrader.com/ctrader-algo/references/Controls/CheckBox/IsThreeState/index.md)
- `public string Text {get; set;}` — Gets or sets the checkbox text. [details](https://help.ctrader.com/ctrader-algo/references/Controls/CheckBox/Text/index.md)

## Events

- `public event Action<CheckBoxEventArgs> Checked;` — Occurs when checked. [details](https://help.ctrader.com/ctrader-algo/references/Controls/CheckBox/Checked/index.md)
- `public event Action<CheckBoxEventArgs> Click;` — Occurs when clicked. [details](https://help.ctrader.com/ctrader-algo/references/Controls/CheckBox/Click/index.md)
- `public event Action<CheckBoxEventArgs> Indeterminate;` — Occurs when indeterminate. [details](https://help.ctrader.com/ctrader-algo/references/Controls/CheckBox/Indeterminate/index.md)
- `public event Action<CheckBoxEventArgs> Unchecked;` — Occurs when unchecked. [details](https://help.ctrader.com/ctrader-algo/references/Controls/CheckBox/Unchecked/index.md)

## Inherited members

- `public Color ForegroundColor {get; set;}` (from Control) [details](https://help.ctrader.com/ctrader-algo/references/Controls/Control/ForegroundColor/index.md)
- `public Color BackgroundColor {get; set;}` (from Control) [details](https://help.ctrader.com/ctrader-algo/references/Controls/Control/BackgroundColor/index.md)
- `public Thickness Padding {get; set;}` (from Control) [details](https://help.ctrader.com/ctrader-algo/references/Controls/Control/Padding/index.md)
- `public VerticalAlignment VerticalContentAlignment {get; set;}` (from Control) [details](https://help.ctrader.com/ctrader-algo/references/Controls/Control/VerticalContentAlignment/index.md)
- `public HorizontalAlignment HorizontalContentAlignment {get; set;}` (from Control) [details](https://help.ctrader.com/ctrader-algo/references/Controls/Control/HorizontalContentAlignment/index.md)
- `public FontWeight FontWeight {get; set;}` (from Control) [details](https://help.ctrader.com/ctrader-algo/references/Controls/Control/FontWeight/index.md)
- `public FontStyle FontStyle {get; set;}` (from Control) [details](https://help.ctrader.com/ctrader-algo/references/Controls/Control/FontStyle/index.md)
- `public string FontFamily {get; set;}` (from Control) [details](https://help.ctrader.com/ctrader-algo/references/Controls/Control/FontFamily/index.md)
- `public double FontSize {get; set;}` (from Control) [details](https://help.ctrader.com/ctrader-algo/references/Controls/Control/FontSize/index.md)
- `public void ResetProperty(ControlProperty property)` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/ResetProperty/index.md)
- `public Guid UniqueId {get;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/UniqueId/index.md)
- `public Style Style {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/Style/index.md)
- `public double Left {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/Left/index.md)
- `public double Top {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/Top/index.md)
- `public double Right {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/Right/index.md)
- `public double Bottom {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/Bottom/index.md)
- `public double Width {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/Width/index.md)
- `public double Height {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/Height/index.md)
- `public double MinWidth {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/MinWidth/index.md)
- `public double MinHeight {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/MinHeight/index.md)
- `public double MaxWidth {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/MaxWidth/index.md)
- `public double MaxHeight {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/MaxHeight/index.md)
- `public bool IsEnabled {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/IsEnabled/index.md)
- `public bool IsVisible {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/IsVisible/index.md)
- `public double Opacity {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/Opacity/index.md)
- `public Thickness Margin {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/Margin/index.md)
- `public VerticalAlignment VerticalAlignment {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/VerticalAlignment/index.md)
- `public HorizontalAlignment HorizontalAlignment {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/HorizontalAlignment/index.md)
- `public Dock Dock {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/Dock/index.md)
- `public bool IsHitTestVisible {get; set;}` (from ControlBase) [details](https://help.ctrader.com/ctrader-algo/references/Controls/ControlBase/IsHitTestVisible/index.md)