Xceed Logo
Shop
Xceed Toolkit for .NET Maui v2.0 Documentation
Xceed.Maui.Toolkit Assembly / Xceed.Maui.Toolkit Namespace / ToggleSwitch Class
Members Example


In This Topic
    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
    '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:

    <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

    Public Constructors
     NameDescription
    Public ConstructorToggleSwitch Constructor  
    Top
    Public Fields
     NameDescription
    Public Fieldstatic (Shared in Visual Basic)CheckedBackgroundProperty  
    Public Fieldstatic (Shared in Visual Basic)CheckedContentProperty  
    Public Fieldstatic (Shared in Visual Basic)IsCheckedLeftProperty  
    Public Fieldstatic (Shared in Visual Basic)IsCheckedProperty  
    Public Fieldstatic (Shared in Visual Basic)ThumbBackgroundProperty  
    Public Fieldstatic (Shared in Visual Basic)ThumbBorderBrushProperty  
    Public Fieldstatic (Shared in Visual Basic)ThumbBorderThicknessProperty  
    Public Fieldstatic (Shared in Visual Basic)ThumbCheckedBackgroundProperty  
    Public Fieldstatic (Shared in Visual Basic)ThumbCheckedContentProperty  
    Public Fieldstatic (Shared in Visual Basic)ThumbUncheckedContentProperty  
    Public Fieldstatic (Shared in Visual Basic)UncheckedContentProperty  
    Top
    Protected Fields
     NameDescription
    Protected FieldpropertyMapper (Inherited from Microsoft.Maui.Controls.View)
    Top
    Public Properties
     NameDescription
    Public PropertyAnchorX (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyAnchorY (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyAutomationId (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyBackgroundGets or sets the Brush that will be used to paint the Control's background. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyBackgroundColor (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyBehaviors (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyBindingContext (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public PropertyBorderBrushGets or sets the Brush that will be used to paint the Control's Border. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyBorderThicknessGets or sets the thickness of this Control's Border. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyBounds (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyCascadeInputTransparent (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public PropertyCheckedBackgroundGets or sets the Brush that will be used to color the ToggleSwitch's background when the Control is in its Checked state.  
    Public PropertyCheckedContentGets or sets the Content that will be displayed when the ToggleSwitch is in its Checked state.  
    Public Propertyclass (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Public PropertyClassId (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyClip (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyControlTemplate (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Public PropertyCornerRadiusGets or sets the radius for the 4 corners of this Control.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyDesiredSize (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyDispatcher (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public PropertyEffects (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyFlowDirection (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyFontAttributesGets or sets the FontAttributes that will be applied to the Control's textual Content.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyFontFamilyGets or sets the font family that will be used to display the Control's textual Content.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyFontSizeGets or sets the font size that will determine the scale of the Control's textual Content.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyFrame (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyGestureRecognizers (Inherited from Microsoft.Maui.Controls.View)
    Public PropertyHandler (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyHeight (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyHeightRequest (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyHorizontalContentOptionsGets or sets how the Control's Content is aligned horizontally. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyHorizontalOptions (Inherited from Microsoft.Maui.Controls.View)
    Public PropertyId (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyInputTransparent (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyIsCheckedGets or sets if the ToggleSwitch is checked.  
    Public PropertyIsCheckedLeftGets or sets if the ToggleSwitch's Checked state is when the thumb is on the left.  
    Public PropertyIsClippedToBounds (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public PropertyIsEnabled (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyIsFocused (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyIsLoaded (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyIsVisible (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyMargin (Inherited from Microsoft.Maui.Controls.View)
    Public PropertyMaximumHeightRequest (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyMaximumWidthRequest (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyMinimumHeightRequest (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyMinimumWidthRequest (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyNavigation (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Public PropertyOpacity (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyOverrideDefaultVisualStatesGets or sets if the Control's VisualStates are overridden or not. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyPaddingGets or sets the amount of padding added around the Control.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyParent (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyResources (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyRotation (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyRotationX (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyRotationY (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyScale (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyScaleX (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyScaleY (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyShadow (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyStyle (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Public PropertyStyleClass (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Public PropertyStyleId (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyTextColorGets or sets the text's Color. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyThumbBackgroundGets or sets the Brush that will be used to color the thumb's background when the ToggleSwitch is in its Unchecked state.  
    Public PropertyThumbBorderBrushGets or sets the thumb's BorderBrush.  
    Public PropertyThumbBorderThicknessGets or sets the thumb's BorderThickness.  
    Public PropertyThumbCheckedBackgroundGets or sets the Brush that will be used to color the thumb's background when the ToggleSwitch is in its Checked state.  
    Public PropertyThumbCheckedContentGets or sets the thumb's Content when the ToggleSwitch is in its Checked state.  
    Public PropertyThumbUncheckedContentGets or sets the thumb's Content when the ToggleSwitch is in its Unchecked state.   
    Public PropertyTranslationX (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyTranslationY (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyTriggers (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyUncheckedContentGets or sets the Content that will be displayed when the ToggleSwitch is in its Unchecked state.  
    Public PropertyVerticalContentOptionsGets or sets how the Control's Content is aligned vertically. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyVerticalOptions (Inherited from Microsoft.Maui.Controls.View)
    Public PropertyVisual (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyWidth (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyWidthRequest (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyWindow (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyX (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyY (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyZIndex (Inherited from Microsoft.Maui.Controls.VisualElement)
    Top
    Protected Properties
     NameDescription
    Protected Internal PropertyGestureController (Inherited from Microsoft.Maui.Controls.View)
    Protected PropertyIsEnabledCore (Inherited from Microsoft.Maui.Controls.VisualElement)
    Top
    Public Methods
     NameDescription
    Public MethodAddLogicalChild (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodArrange (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public MethodBatchBegin (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public MethodBatchCommit (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public MethodClearLogicalChildren (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodClearValueOverloaded.  (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodCoerceValueOverloaded.  (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodCrossPlatformArrange (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public MethodCrossPlatformMeasure (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public MethodFindByName (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodFocus (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public MethodForceLayout (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public MethodGetChildElements (Inherited from Microsoft.Maui.Controls.View)
    Public MethodGetValue (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodInsertLogicalChild (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodIsSet (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodLayout (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public MethodLowerChild (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public MethodMeasure (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public MethodRaiseChild (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public MethodRaiseIsCheckedLeftValueChangedEvent  
    Public MethodRaiseIsCheckedValueChangedEvent  
    Public MethodRemoveBinding (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodRemoveDynamicResource (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodRemoveLogicalChild (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodResolveControlTemplate (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Public MethodSetBinding (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodSetDynamicResource (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodSetValueOverloaded.  (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodUnfocus (Inherited from Microsoft.Maui.Controls.VisualElement)
    Top
    Protected Methods
     NameDescription
    Protected MethodApplyBindings (Inherited from Microsoft.Maui.Controls.BindableObject)
    Protected MethodArrangeOverride (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected Internal MethodChangeVisualState (Inherited from Microsoft.Maui.Controls.View)
    Protected MethodFinalize (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected Internal MethodGetRendererOverrides (Inherited from Microsoft.Maui.Controls.View)
    Protected MethodGetTemplateChild (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected MethodInvalidateLayout (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected MethodInvalidateMeasure (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected MethodInvalidateMeasureOverride (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected MethodLayoutChildren (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected MethodMeasureOverride (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected MethodOnApplyTemplateOverridden.   
    Protected MethodOnBindingContextChanged (Inherited from Microsoft.Maui.Controls.View)
    Protected MethodOnChildAdded (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected MethodOnChildMeasureInvalidatedOverloaded.  (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected MethodOnChildRemoved (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected MethodOnChildrenReordered (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected MethodOnFontAttributesChanged (Inherited from Xceed.Maui.Toolkit.Control)
    Protected MethodOnFontFamilyChanged (Inherited from Xceed.Maui.Toolkit.Control)
    Protected MethodOnFontSizeChanged (Inherited from Xceed.Maui.Toolkit.Control)
    Protected MethodOnHandlerChanged (Inherited from Microsoft.Maui.Controls.Element)
    Protected MethodOnHandlerChanging (Inherited from Microsoft.Maui.Controls.Element)
    Protected MethodOnIsCheckedLeftValueChanged  
    Protected MethodOnIsCheckedValueChanged  
    Protected MethodOnMeasure (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected MethodOnParentChanged (Inherited from Microsoft.Maui.Controls.Element)
    Protected MethodOnParentChanging (Inherited from Microsoft.Maui.Controls.Element)
    Protected MethodOnParentSet (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Protected MethodOnPropertyChanged (Inherited from Xceed.Maui.Toolkit.Control)
    Protected MethodOnPropertyChanging (Inherited from Microsoft.Maui.Controls.BindableObject)
    Protected MethodOnSizeAllocated (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected MethodOnTextColorChanged (Inherited from Xceed.Maui.Toolkit.Control)
    Protected MethodRefreshIsEnabledProperty (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected MethodShouldInvalidateOnChildAdded (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected MethodShouldInvalidateOnChildRemoved (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected MethodSizeAllocated (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected MethodUnapplyBindings (Inherited from Microsoft.Maui.Controls.BindableObject)
    Protected MethodUpdateChildrenLayout (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Top
    Public Events
     NameDescription
    Public EventBindingContextChanged (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public EventChildAdded (Inherited from Microsoft.Maui.Controls.Element)
    Public EventChildRemoved (Inherited from Microsoft.Maui.Controls.Element)
    Public EventChildrenReordered (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public EventDescendantAdded (Inherited from Microsoft.Maui.Controls.Element)
    Public EventDescendantRemoved (Inherited from Microsoft.Maui.Controls.Element)
    Public EventFocused (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public EventHandlerChanged (Inherited from Microsoft.Maui.Controls.Element)
    Public EventHandlerChanging (Inherited from Microsoft.Maui.Controls.Element)
    Public EventIsCheckedLeftValueChangedThe event that is raised when the value of the IsCheckedLeft property is changed.  
    Public EventIsCheckedValueChangedThe event that is raised when the ToggleSwitch changes state.  
    Public EventLayoutChanged (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public EventLoaded (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public EventMeasureInvalidated (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public EventParentChanged (Inherited from Microsoft.Maui.Controls.Element)
    Public EventParentChanging (Inherited from Microsoft.Maui.Controls.Element)
    Public EventPropertyChanged (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public EventPropertyChanging (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public EventSizeChanged (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public EventUnfocused (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public EventUnloaded (Inherited from Microsoft.Maui.Controls.VisualElement)
    Top
    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

    See Also

    Reference

    ToggleSwitch Members
    Xceed.Maui.Toolkit Namespace

    Send Feedback