menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfCheckBox - MAUI API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfCheckBox

    SfCheckBox for used to create checkbox with the tick mark, and colors.

    Inheritance
    System.Object
    SfView
    ToggleButton
    SfCheckBox
    Implements
    IDrawableLayout
    Microsoft.Maui.Graphics.IDrawable
    Microsoft.Maui.IAbsoluteLayout
    Microsoft.Maui.ILayout
    Microsoft.Maui.IView
    Microsoft.Maui.IElement
    Microsoft.Maui.ITransform
    Microsoft.Maui.IContainer
    System.Collections.Generic.IList<Microsoft.Maui.IView>
    System.Collections.Generic.ICollection<Microsoft.Maui.IView>
    System.Collections.Generic.IEnumerable<Microsoft.Maui.IView>
    System.Collections.IEnumerable
    Microsoft.Maui.ISafeAreaView
    Microsoft.Maui.IPadding
    Microsoft.Maui.ICrossPlatformLayout
    Microsoft.Maui.IVisualTreeElement
    Inherited Members
    SfView.ArrangeContent(Rect)
    SfView.ArrangeOverride(Rect)
    SfView.Children
    SfView.ClipToBounds
    SfView.IDrawableLayout.DrawingOrder
    SfView.IDrawableLayout.InvalidateDrawable()
    SfView.MeasureOverride(Double, Double)
    SfView.Padding
    ToggleButton.CheckedColor
    ToggleButton.CheckedColorProperty
    ToggleButton.ContentSpacing
    ToggleButton.ContentSpacingProperty
    ToggleButton.ControlSize
    ToggleButton.ControlSizeProperty
    ToggleButton.EnabledAnimation
    ToggleButton.EnabledAnimationProperty
    ToggleButton.FlowDirection
    ToggleButton.FlowDirectionProperty
    ToggleButton.FontAttributes
    ToggleButton.FontAttributesProperty
    ToggleButton.FontAutoScalingEnabled
    ToggleButton.FontAutoScalingEnabledProperty
    ToggleButton.FontFamily
    ToggleButton.FontFamilyProperty
    ToggleButton.FontSize
    ToggleButton.FontSizeProperty
    ToggleButton.HorizontalTextAlignment
    ToggleButton.HorizontalTextAlignmentProperty
    ToggleButton.IsEnabled
    ToggleButton.IsEnabledProperty
    ToggleButton.StateChanged
    ToggleButton.StateChanging
    ToggleButton.StrokeThickness
    ToggleButton.StrokeThicknessProperty
    ToggleButton.Text
    ToggleButton.TextColor
    ToggleButton.TextColorProperty
    ToggleButton.TextProperty
    ToggleButton.UncheckedColor
    ToggleButton.UncheckedColorProperty
    Namespace: Syncfusion.Maui.Buttons
    Assembly: Syncfusion.Maui.Buttons.dll
    Syntax
    public class SfCheckBox : ToggleButton, IDrawableLayout, IDrawable, IAbsoluteLayout, ILayout, IView, IElement, ITransform, IContainer, IList<IView>, ICollection<IView>, IEnumerable<IView>, IEnumerable, ISafeAreaView, IPadding, ICrossPlatformLayout, IVisualTreeElement, ISemanticsProvider, ITextElement, ITouchListener, ITapGestureListener, IGestureListener, IParentThemeElement, IThemeElement

    Constructors

    SfCheckBox()

    Initialize the new instance of SfCheckBox class

    Declaration
    public SfCheckBox()

    Fields

    CornerRadiusProperty

    Identifies the CornerRadiusProperty BindableProperty.

    Declaration
    public static readonly BindableProperty CornerRadiusProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    IsCheckedProperty

    Identifies the IsCheckedProperty BindableProperty.

    Declaration
    public static readonly BindableProperty IsCheckedProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    IsThreeStateProperty

    Backing store for IsThreeState property.

    Declaration
    public static readonly BindableProperty IsThreeStateProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    LineBreakModeProperty

    Gets or sets the Line Break Mode for SfCheckBox.This is a Bindable property.

    Declaration
    public static readonly BindableProperty LineBreakModeProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    TickColorProperty

    Identifies the TickColorProperty BindableProperty.

    Declaration
    public static readonly BindableProperty TickColorProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    Properties

    CornerRadius

    Gets or sets the corner radius of the SfCheckBox.

    Declaration
    public CornerRadius CornerRadius { get; set; }
    Property Value
    Type
    Microsoft.Maui.CornerRadius

    IsChecked

    Gets or Sets the IsChecked.

    Declaration
    public Nullable<bool> IsChecked { get; set; }
    Property Value
    Type
    System.Nullable<System.Boolean>

    IsThreeState

    Gets or sets a value indicating whether the control supports three states.

    Declaration
    public bool IsThreeState { get; set; }
    Property Value
    Type
    System.Boolean

    LineBreakMode

    Gets or sets the value indicating the LineBreakMode for the CheckBox's text.

    Declaration
    public LineBreakMode LineBreakMode { get; set; }
    Property Value
    Type Description
    Microsoft.Maui.LineBreakMode

    Accepts LineBreakMode values, with the default being NoWrap.

    TickColor

    Gets or sets the TickColor of the SfCheckbox

    Declaration
    public Color TickColor { get; set; }
    Property Value
    Type
    Microsoft.Maui.Graphics.Color

    Methods

    ChangeVisualState()

    Updates the state of the visual.

    Declaration
    protected override void ChangeVisualState()

    GetSemanticsNodesCore(Double, Double)

    Returns the semantics node list

    Declaration
    protected override List<SemanticsNode> GetSemanticsNodesCore(double width, double height)
    Parameters
    Type Name Description
    System.Double width
    System.Double height
    Returns
    Type
    System.Collections.Generic.List<Syncfusion.Maui.Graphics.Internals.SemanticsNode>
    Overrides
    SfView.GetSemanticsNodesCore(Double, Double)

    MeasureContent(Double, Double)

    Measure content method.

    Declaration
    protected override Size MeasureContent(double widthConstraint, double heightConstraint)
    Parameters
    Type Name Description
    System.Double widthConstraint
    System.Double heightConstraint
    Returns
    Type
    Microsoft.Maui.Graphics.Size
    Overrides
    SfView.MeasureContent(Double, Double)

    OnBindingContextChanged()

    This will be triggered when the CheckBox is recycled in a virtualized list and gets a new binding context

    Declaration
    protected override void OnBindingContextChanged()
    Overrides
    SfView.OnBindingContextChanged()

    OnDraw(ICanvas, RectF)

    The method is used to draw the customized controls

    Declaration
    protected override void OnDraw(ICanvas canvas, RectF dirtyRect)
    Parameters
    Type Name Description
    Microsoft.Maui.Graphics.ICanvas canvas
    Microsoft.Maui.Graphics.RectF dirtyRect
    Overrides
    SfView.OnDraw(ICanvas, RectF)

    OnHandlerChanged()

    Declaration
    protected override void OnHandlerChanged()
    Overrides
    SfView.OnHandlerChanged()

    OnPropertyChanged(String)

    Declaration
    protected override void OnPropertyChanged(string propertyName = null)
    Parameters
    Type Name Description
    System.String propertyName

    Implements

    IDrawableLayout
    Microsoft.Maui.Graphics.IDrawable
    Microsoft.Maui.IAbsoluteLayout
    Microsoft.Maui.ILayout
    Microsoft.Maui.IView
    Microsoft.Maui.IElement
    Microsoft.Maui.ITransform
    Microsoft.Maui.IContainer
    System.Collections.Generic.IList<>
    System.Collections.Generic.ICollection<>
    System.Collections.Generic.IEnumerable<>
    System.Collections.IEnumerable
    Microsoft.Maui.ISafeAreaView
    Microsoft.Maui.IPadding
    Microsoft.Maui.ICrossPlatformLayout
    Microsoft.Maui.IVisualTreeElement
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved