ToggleSwitch Class

In This Topic

This control is similar to MAUI Framework's Switch control, but is more flexible than said control since, for example, it is possible to modify the ToggleSwitch's size & style, as well as set different Content & thumb for both the Checked & Unchecked state. Xceed's ToggleSwitch also allows to set which side of the Control is the Checked side & offers two ways to move the thumb from one state to the other: by click & dragging the thumb or by simply clicking on the Checked/Unchecked area.

Syntax

Visual Basic
C#

'Declaration
 
Public Class ToggleSwitch 
   Inherits Control
   Implements Microsoft.Maui.Controls.IAnimatable, Microsoft.Maui.Controls.IEffectControlProvider, Microsoft.Maui.Controls.IElementController, Microsoft.Maui.Controls.IGestureRecognizers, Microsoft.Maui.Controls.ILayout, Microsoft.Maui.Controls.ILayoutController, Microsoft.Maui.Controls.Internals.IGestureController, Microsoft.Maui.Controls.IViewController, Microsoft.Maui.Controls.IVisualElementController, Microsoft.Maui.HotReload.IHotReloadableView, Microsoft.Maui.IContentView, Microsoft.Maui.IContextFlyoutElement, Microsoft.Maui.ICrossPlatformLayout, Microsoft.Maui.IElement, Microsoft.Maui.IPadding, Microsoft.Maui.IPropertyMapperView, Microsoft.Maui.IReplaceableView, Microsoft.Maui.IToolTipElement, Microsoft.Maui.ITransform, Microsoft.Maui.IView, Microsoft.Maui.IVisualTreeElement

'Usage
 
Dim instance As ToggleSwitch

public class ToggleSwitch : Control, Microsoft.Maui.Controls.IAnimatable, Microsoft.Maui.Controls.IEffectControlProvider, Microsoft.Maui.Controls.IElementController, Microsoft.Maui.Controls.IGestureRecognizers, Microsoft.Maui.Controls.ILayout, Microsoft.Maui.Controls.ILayoutController, Microsoft.Maui.Controls.Internals.IGestureController, Microsoft.Maui.Controls.IViewController, Microsoft.Maui.Controls.IVisualElementController, Microsoft.Maui.HotReload.IHotReloadableView, Microsoft.Maui.IContentView, Microsoft.Maui.IContextFlyoutElement, Microsoft.Maui.ICrossPlatformLayout, Microsoft.Maui.IElement, Microsoft.Maui.IPadding, Microsoft.Maui.IPropertyMapperView, Microsoft.Maui.IReplaceableView, Microsoft.Maui.IToolTipElement, Microsoft.Maui.ITransform, Microsoft.Maui.IView, Microsoft.Maui.IVisualTreeElement

Example

The following code would display this control:

XAML

<xctk:ToggleSwitch IsChecked="True"
                   IsCheckedLeft="False"
                   CheckedBackground="Red"
                   Background="Pink"
                   CheckedContent="ON"
                   UncheckedContent="OFF"
                   HorizontalOptions="Center"
                   BorderBrush="Orange"
                   BorderThickness="4"
                   CornerRadius="15"
                   WidthRequest="150"
                   HeightRequest="40"/>

Inheritance Hierarchy

System.Object
   Microsoft.Maui.Controls.BindableObject
      Microsoft.Maui.Controls.Element
         Microsoft.Maui.Controls.NavigableElement
            Microsoft.Maui.Controls.VisualElement
               Microsoft.Maui.Controls.View
                  Microsoft.Maui.Controls.Compatibility.Layout
                     Microsoft.Maui.Controls.TemplatedView
                        Xceed.Maui.Toolkit.Control
                           Xceed.Maui.Toolkit.ToggleSwitch

Requirements

Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ToggleSwitch Members
Xceed.Maui.Toolkit Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference