Back to Devexpress

ToggleSwitch.IsOn Property

windowsforms-devexpress-dot-xtraeditors-dot-toggleswitch.md

latest5.9 KB
Original Source

ToggleSwitch.IsOn Property

Gets or sets the control’s check state.

Namespace : DevExpress.XtraEditors

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[DefaultValue(false)]
[DXCategory("Appearance")]
public bool IsOn { get; set; }
vb
<DXCategory("Appearance")>
<DefaultValue(False)>
Public Property IsOn As Boolean

Property Value

TypeDefaultDescription
Booleanfalse

true if the control is checked; otherwise, false.

|

Remarks

In the checked and unchecked states, the control displays text specified by the RepositoryItemToggleSwitch.OnText and RepositoryItemToggleSwitch.OffText properties, respectively. These properties are accessible via the ToggleSwitch.Properties object.

You can toggle the control’s check state via the ToggleSwitch.Toggle method.

The IsOn property is synchronized with the control’s ToggleSwitch.EditValue property.

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

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.

winforms-pivotgrid-how-to-display-underlying-data/CS/DrillDownDataSourceExample/Form1.cs#L59

csharp
{
    serverMode = ((ToggleSwitch)sender).IsOn;
    SetPivotGridDataSource();

winforms-pivotgrid-entity-framework-server-mode/CS/EntityFrameworkServerModeExample/Form1.cs#L33

csharp
{
    serverMode = ((ToggleSwitch)sender).IsOn;
    SetPivotGridDataSource();

winforms-pivotgrid--display-the-difference-of-income-and-outlay-in-totals/CS/PivotGridCustomSummaryExample/Form1.cs#L35

csharp
{
    if (((DevExpress.XtraEditors.ToggleSwitch)sender).IsOn) {
        MigrateToOptimizedMode();

winforms-pivotgrid-linq-to-sql-server-mode/CS/LinqToSqlServerModeExample/Form1.cs#L35

csharp
{
    serverMode = ((ToggleSwitch)sender).IsOn;
    SetPivotGridDataSource();

winforms-pivotgrid-how-to-display-underlying-data/VB/DrillDownDataSourceExample/Form1.vb#L56

vb
Private Sub toggleSwitch1_Toggled(ByVal sender As Object, ByVal e As EventArgs) Handles toggleSwitch1.Toggled
    serverMode = DirectCast(sender, ToggleSwitch).IsOn
    SetPivotGridDataSource()

winforms-pivotgrid-entity-framework-server-mode/VB/EntityFrameworkServerModeExample/Form1.vb#L26

vb
Private Sub toggleSwitch1_Toggled(ByVal sender As Object, ByVal e As EventArgs) Handles toggleSwitch1.Toggled
    serverMode = DirectCast(sender, ToggleSwitch).IsOn
    SetPivotGridDataSource()

winforms-pivotgrid--display-the-difference-of-income-and-outlay-in-totals/VB/PivotGridCustomSummaryExample/Form1.vb#L28

vb
Private Sub toggleOptimizedMode_Toggled(ByVal sender As Object, ByVal e As EventArgs) Handles toggleOptimizedMode.Toggled
    If DirectCast(sender, DevExpress.XtraEditors.ToggleSwitch).IsOn Then
        MigrateToOptimizedMode()

winforms-pivotgrid-linq-to-sql-server-mode/VB/LinqToSqlServerModeExample/Form1.vb#L28

vb
Private Sub toggleSwitch1_Toggled(ByVal sender As Object, ByVal e As EventArgs) Handles toggleSwitch1.Toggled
    serverMode = DirectCast(sender, ToggleSwitch).IsOn
    SetPivotGridDataSource()

See Also

ToggleSwitch Class

ToggleSwitch Members

DevExpress.XtraEditors Namespace