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

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

# ToggleButton (class)

Represents the Toggle button.

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 ToggleButton : Control
```

## Examples

C#:

```csharp
using cAlgo.API;
using System;
using System.Linq;

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

            for (int i = 0; i < 5; i++)
            {
                var toggleButton = new ToggleButton
                {
                    Text = "Toggle Button #" + i + " Unchecked",
                    Margin = 10
                };

                toggleButton.Checked += ToggleButton_Checked;
                toggleButton.Unchecked += ToggleButton_Unchecked;

                stackPanel.AddChild(toggleButton);
            }

            Chart.AddControl(stackPanel);
        }

        private void ToggleButton_Checked(ToggleButtonEventArgs obj)
        {
            var textSplit = obj.ToggleButton.Text.Split(' ').TakeWhile(text => !text.Equals("Unchecked", StringComparison.OrdinalIgnoreCase)).ToArray();

            obj.ToggleButton.Text = string.Join(" ", textSplit) + " Checked";
        }

        private void ToggleButton_Unchecked(ToggleButtonEventArgs obj)
        {
            var textSplit = obj.ToggleButton.Text.Split(' ').TakeWhile(text => !text.Equals("Checked", StringComparison.OrdinalIgnoreCase)).ToArray();

            obj.ToggleButton.Text = string.Join(" ", textSplit) + " Unchecked";
        }

        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
        stackPanel.Opacity = 0.7

        for i in range(5):
            toggleButton = ToggleButton()
            toggleButton.Text = f"Toggle Button # {i} Unchecked"
            toggleButton.Margin = Thickness(10)
            toggleButton.Checked += self.on_toggle_button_checked
            toggleButton.Unchecked += self.on_toggle_button_unchecked

            stackPanel.AddChild(toggleButton)

        api.Chart.AddControl(stackPanel)

    def on_toggle_button_checked(self, args):
        textSplit = args.ToggleButton.Text.split(' ')[:4]
        args.ToggleButton.Text = f"{' '.join(textSplit)} Checked"

    def on_toggle_button_unchecked(self, args):
        textSplit = args.ToggleButton.Text.split(' ')[:4]
        args.ToggleButton.Text = f"{' '.join(textSplit)} Unchecked"
```

config.json:

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

## Constructors

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

## Properties

- `public Color BorderColor {get; set;}` — Gets or sets the border line color. [details](https://help.ctrader.com/ctrader-algo/references/Controls/ToggleButton/BorderColor/index.md)
- `public Thickness BorderThickness {get; set;}` — Gets or sets the border thickness. Property value can be set using Thickness, number, or a string new Thickness(5), new Thickness(1, 2, 3, 4), 5, "5", "1 2 3 4". [details](https://help.ctrader.com/ctrader-algo/references/Controls/ToggleButton/BorderThickness/index.md)
- `public ControlBase Content {get; set;}` — Gets or sets the content. [details](https://help.ctrader.com/ctrader-algo/references/Controls/ToggleButton/Content/index.md)
- `public CornerRadius CornerRadius {get; set;}` — Gets or sets the border corner radius. Property value can be set using CornerRadius, number, or a string: new CornerRadius(5), new CornerRadius(1, 2, 3, 4). [details](https://help.ctrader.com/ctrader-algo/references/Controls/ToggleButton/CornerRadius/index.md)
- `public bool IsChecked {get; set;}` — Defines whether the Toggle button is checked. [details](https://help.ctrader.com/ctrader-algo/references/Controls/ToggleButton/IsChecked/index.md)
- `public string Text {get; set;}` — Gets or sets the text. [details](https://help.ctrader.com/ctrader-algo/references/Controls/ToggleButton/Text/index.md)

## Events

- `public event Action<ToggleButtonEventArgs> Checked;` — Occurs when checked. [details](https://help.ctrader.com/ctrader-algo/references/Controls/ToggleButton/Checked/index.md)
- `public event Action<ToggleButtonEventArgs> Click;` — Occurs when clicked. [details](https://help.ctrader.com/ctrader-algo/references/Controls/ToggleButton/Click/index.md)
- `public event Action<ToggleButtonEventArgs> Unchecked;` — Occurs when unchecked. [details](https://help.ctrader.com/ctrader-algo/references/Controls/ToggleButton/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)