ToggleSwitch.IsOn Property

Gets or sets the control’s check state.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DXCategory("Appearance")]
[DefaultValue(false)]
public bool IsOn { get; set; }

VB.NET

<DXCategory("Appearance")>
<DefaultValue(False)>
Public Property IsOn As Boolean

Property Value

Type	Default	Description
Boolean	**false**	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.

Related GitHub Examples

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.

C#

vote-app-t445500/CS/VoteApp/Map.cs#L93

lbElection.Text = electionData.Title + " " + electionData.Year + (tsElectionSimilutor.IsOn && voteResultsAltered ? " </i>(altered)" : "");

vote-applications-t446758/CS/VoteApp/Map.cs#L92

((MapOverlayTextItem)mapControl.Overlays[0].Items[0]).Text = electionData.Source;
lbElection.Text = electionData.Title + " " + electionData.Year + (tsElectionSimilutor.IsOn && voteResultsAltered ? " </i>(altered)" : "");

how-to-put-any-control-in-the-ribbonform-header-t236177/CS/Form1.cs#L24

{
    this.AllowFormGlass = toggleSwitch1.IsOn ? DefaultBoolean.True : DefaultBoolean.False;
}

how-to-customize-the-tooltips-shown-for-appointments-e155/CS/AppointmentToolTips/Form1.cs#L103

private void toggleSwitch1_Toggled(object sender, EventArgs e) {
    if (toggleSwitch1.IsOn) {
        schedulerControl1.AppointmentViewInfoCustomizing -= SchedulerControl1_AppointmentViewInfoCustomizing;

winforms-dashboard-viewer-item-tabs/CS/TabSupportExample/Form1.cs#L91

{
    if (((ToggleSwitch)sender).IsOn)
    {

VB.NET

how-to-put-any-control-in-the-ribbonform-header-t236177/VB/Form1.vb#L22

Private Sub toggleSwitch1_Toggled(ByVal sender As Object, ByVal e As EventArgs) Handles toggleSwitch1.Toggled
    Me.AllowFormGlass = If(toggleSwitch1.IsOn, DefaultBoolean.True, DefaultBoolean.False)
End Sub

how-to-customize-the-tooltips-shown-for-appointments-e155/VB/AppointmentToolTips/Form1.vb#L109

Private Sub toggleSwitch1_Toggled(ByVal sender As Object, ByVal e As EventArgs) Handles toggleSwitch1.Toggled
    If Me.toggleSwitch1.IsOn Then
        RemoveHandler Me.schedulerControl1.AppointmentViewInfoCustomizing, AddressOf SchedulerControl1_AppointmentViewInfoCustomizing

winforms-dashboard-viewer-item-tabs/VB/TabSupportExample/Form1.vb#L87

Private Sub toggleSwitchTimer_Toggled(ByVal sender As Object, ByVal e As EventArgs) Handles toggleSwitchTimer.Toggled
    If DirectCast(sender, ToggleSwitch).IsOn Then
        timedTabContainerName = dashboardViewer1.Dashboard.Items.FindFirst(Function(x) TypeOf x Is TabContainerDashboardItem).ComponentName

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

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

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

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