ToggleSwitch Class

The check editor to edit Boolean values using a movable bar.

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

C#
VB.NET

[SmartTagFilter(typeof(ToggleSwitchFilter))]
[SmartTagAction(typeof(ToggleSwitchActions), "On", "Switch On", SmartTagActionType.RefreshContentAfterExecute)]
[SmartTagAction(typeof(ToggleSwitchActions), "Off", "Switch Off", SmartTagActionType.RefreshContentAfterExecute)]
[ToolboxTabName("DX.18.1: Common Controls")]
[ToolboxBitmap(typeof(ToolboxIconsRootNS), "ToggleSwitch")]
[DefaultBindingPropertyEx("IsOn")]
public class ToggleSwitch :
    BaseCheckEdit

<SmartTagAction(GetType(ToggleSwitchActions), "On", "Switch On", SmartTagActionType.RefreshContentAfterExecute)>
<DefaultBindingPropertyEx("IsOn")>
<SmartTagFilter(GetType(ToggleSwitchFilter))>
<ToolboxTabName("DX.18.1: Common Controls")>
<SmartTagAction(GetType(ToggleSwitchActions), "Off", "Switch Off", SmartTagActionType.RefreshContentAfterExecute)>
<ToolboxBitmap(GetType(ToolboxIconsRootNS), "ToggleSwitch")>
Public Class ToggleSwitch
    Inherits BaseCheckEdit

Remarks

The ToggleSwitch is a Windows UI-style check editor that allows an end-user to switch between two states (On and Off).

The editor’s state is specified by the ToggleSwitch.IsOn property. The ToggleSwitch.Toggle method inverts the current state.

The text displayed by the editor in the checked and unchecked states is specified by the RepositoryItemToggleSwitch.OnText and RepositoryItemToggleSwitch.OffText properties, available via the ToggleSwitch.Properties object. To hide the text, use the RepositoryItemToggleSwitch.ShowText property.

The following code snippets (auto-collected from DevExpress Examples) contain references to the ToggleSwitch class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#
VB.NET

how-to-place-text-inside-toggleswitch-e4965/CS/WindowsFormsApplication1/CustomToggleSwitch.cs#L51

[ToolboxItem(true)]
public class CustomToggle : ToggleSwitch
{

toggleswitch-how-to-modify-size-of-thumb-image-and-backing-image-t264643/CS/WindowsFormsApplication31/CustomToggleSwitch.cs#L18

[ToolboxItem(true)]
public class CustomToggleSwitch : ToggleSwitch {
    static CustomToggleSwitch() {

create-accordioncontrol-in-code-t500006/CS/AccordionControl-ex/Form1.cs#L75

HyperlinkLabelControl hyperlinkLabelControl1 = new HyperlinkLabelControl();
ToggleSwitch toggleSwitch1 = new ToggleSwitch();
acControl.Controls.Add(itemSettingsControlContainer);

how-to-place-text-inside-toggleswitch-e4965/VB/WindowsFormsApplication1/CustomToggleSwitch.vb#L53

Public Class CustomToggle
    Inherits ToggleSwitch

toggleswitch-how-to-modify-size-of-thumb-image-and-backing-image-t264643/VB/WindowsFormsApplication31/CustomToggleSwitch.vb#L19

Public Class CustomToggleSwitch
    Inherits ToggleSwitch

create-accordioncontrol-in-code-t500006/VB/AccordionControl-ex/Form1.vb#L75

Dim hyperlinkLabelControl1 As New HyperlinkLabelControl()
Dim toggleSwitch1 As New ToggleSwitch()
acControl.Controls.Add(itemSettingsControlContainer)