WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class CheckRadioBase

    Show / Hide Table of Contents

    Class CheckRadioBase

    Represents an abstract class for CheckRadioBase class.

    Inheritance
    System.Object
    BaseControl
    ThemedControl
    CheckRadioBase
    CheckBoxAdv
    RadioButtonAdv
    Implements
    System.IDisposable
    System.Windows.Forms.IMessageFilter
    IThemeProvider
    IVisualStyle
    Inherited Members
    ThemedControl.WndProc(Message)
    ThemedControl.ThemesEnabled
    ThemedControl.ThemeChanged
    BaseControl.OnThemeNameChanged(String)
    BaseControl.GetControlName(String)
    BaseControl.OnCanApplyThemeChanged(Boolean)
    BaseControl.OnCanOverrideStyleChanged(Boolean)
    BaseControl.IsVisualStyleEnabled
    Namespace: Syncfusion.Windows.Forms.Tools
    Assembly: Syncfusion.Tools.Windows.dll
    Syntax
    public abstract class CheckRadioBase : ThemedControl, IDisposable, IMessageFilter, IThemeProvider, IVisualStyle

    Constructors

    CheckRadioBase()

    Initializes a new instance of the CheckRadioBase class.

    Declaration
    public CheckRadioBase()

    Fields

    backStyle

    The background style of the CheckBox.

    Declaration
    protected CheckBoxAdvBackStyle backStyle
    Field Value
    Type Description
    CheckBoxAdvBackStyle

    buttonState

    Determines the state of the checkbox.

    Declaration
    protected ButtonState buttonState
    Field Value
    Type Description
    System.Windows.Forms.ButtonState

    focusRect

    The focus rectangle.

    Declaration
    protected Rectangle focusRect
    Field Value
    Type Description
    System.Drawing.Rectangle

    m_TextFormatFlags

    Declaration
    protected TextFormatFlags m_TextFormatFlags
    Field Value
    Type Description
    System.Windows.Forms.TextFormatFlags

    malignCheckBox

    Alignment for checkbox.

    Declaration
    protected ContentAlignment malignCheckBox
    Field Value
    Type Description
    System.Drawing.ContentAlignment

    malignText

    The alignment of the text.

    Declaration
    protected ContentAlignment malignText
    Field Value
    Type Description
    System.Drawing.ContentAlignment

    mautoHeight

    Indicates whether the height of the CheckBox will be automatically calculated.

    Declaration
    protected bool mautoHeight
    Field Value
    Type Description
    System.Boolean

    mbinitializing

    Indicates whether it is initializing stage.

    Declaration
    protected bool mbinitializing
    Field Value
    Type Description
    System.Boolean

    mborder3DStyle

    The 3D border style of the CheckBox.

    Declaration
    protected Border3DStyle mborder3DStyle
    Field Value
    Type Description
    System.Windows.Forms.Border3DStyle

    mborderColor

    The color of the border.

    Declaration
    protected Color mborderColor
    Field Value
    Type Description
    System.Drawing.Color

    mborderSingle

    The border style of the CheckBox.

    Declaration
    protected ButtonBorderStyle mborderSingle
    Field Value
    Type Description
    System.Windows.Forms.ButtonBorderStyle

    mborderStyle

    The 2D border style of the CheckBox.

    Declaration
    protected BorderStyle mborderStyle
    Field Value
    Type Description
    System.Windows.Forms.BorderStyle

    mbtextRender

    Internal flag which indicates whether text will be rendered.

    Declaration
    protected bool mbtextRender
    Field Value
    Type Description
    System.Boolean

    mcheckedImage

    The image when checked.

    Declaration
    protected Image mcheckedImage
    Field Value
    Type Description
    System.Drawing.Image

    mdisabledImage

    The image when disabled.

    Declaration
    protected Image mdisabledImage
    Field Value
    Type Description
    System.Drawing.Image

    mdrawFocusRectangle

    Indicates whether the focus rectangle will be visible.

    Declaration
    protected bool mdrawFocusRectangle
    Field Value
    Type Description
    System.Boolean

    mgradientEnd

    The end color of the gradient.

    Declaration
    protected Color mgradientEnd
    Field Value
    Type Description
    System.Drawing.Color

    mgradientStart

    The start color of the gradient.

    Declaration
    protected Color mgradientStart
    Field Value
    Type Description
    System.Drawing.Color

    mhotBorderColor

    The color of the border when mouse over.

    Declaration
    protected Color mhotBorderColor
    Field Value
    Type Description
    System.Drawing.Color

    mimageCheckBox

    Indicates whether the checkbox will draw itself with the images provided.

    Declaration
    protected bool mimageCheckBox
    Field Value
    Type Description
    System.Boolean

    mindeterminateImage

    The image when indeterminate.

    Declaration
    protected Image mindeterminateImage
    Field Value
    Type Description
    System.Drawing.Image

    mmouseDown

    Indicates whether the mouse button is pressed.

    Declaration
    protected bool mmouseDown
    Field Value
    Type Description
    System.Boolean

    mmouseOver

    Indicates whether the mouse is over the control.

    Declaration
    protected bool mmouseOver
    Field Value
    Type Description
    System.Boolean

    mmouseOverCheckedImage

    The image when checked and mouse over.

    Declaration
    protected Image mmouseOverCheckedImage
    Field Value
    Type Description
    System.Drawing.Image

    mmouseOverIndetermImage

    The image when indeterminate and mouse over.

    Declaration
    protected Image mmouseOverIndetermImage
    Field Value
    Type Description
    System.Drawing.Image

    mmouseOverUncheckedImage

    The image when unchecked and mouse over.

    Declaration
    protected Image mmouseOverUncheckedImage
    Field Value
    Type Description
    System.Drawing.Image

    mrectBox

    Rectangle used to draw checkbox in.

    Declaration
    protected Rectangle mrectBox
    Field Value
    Type Description
    System.Drawing.Rectangle

    mrectText

    Text Location.

    Declaration
    protected Rectangle mrectText
    Field Value
    Type Description
    System.Drawing.Rectangle

    mshadowColor

    The color of the text shadow.

    Declaration
    protected Color mshadowColor
    Field Value
    Type Description
    System.Drawing.Color

    mshadowOffset

    Determines the offset of the shadow.

    Declaration
    protected Point mshadowOffset
    Field Value
    Type Description
    System.Drawing.Point

    mstretchImage

    Indicates whether the images will be stretched when drawing over the checkbox.

    Declaration
    protected bool mstretchImage
    Field Value
    Type Description
    System.Boolean

    mszImagedBox

    Image checkbox size.

    Declaration
    protected Size mszImagedBox
    Field Value
    Type Description
    System.Drawing.Size

    mtextAlignment

    The alignment of the text.

    Declaration
    protected ContentAlignment mtextAlignment
    Field Value
    Type Description
    System.Drawing.ContentAlignment

    muncheckedImage

    The image when unchecked.

    Declaration
    protected Image muncheckedImage
    Field Value
    Type Description
    System.Drawing.Image

    mwrapText

    Indicates whether the text will be wrapped.

    Declaration
    protected bool mwrapText
    Field Value
    Type Description
    System.Boolean

    tcd

    Helps in the themed drawing of the control.

    Declaration
    protected ThemedControlDrawing tcd
    Field Value
    Type Description
    ThemedControlDrawing

    textOffset

    Determines the position of the text.

    Declaration
    protected Point textOffset
    Field Value
    Type Description
    System.Drawing.Point

    Properties

    AutoEllipsis

    Gets or sets a value indicating whether the AutoEllipsis is applied when the size is small.

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

    AutoHeight

    Gets or sets a value indicating whether the CheckBox will automatically calculate it`s height.

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

    AutoSize

    Gets or sets a value specifies whether a control will automatically size itself to fit its contents.

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

    BackgroundStyle

    Gets or sets the background style of the CheckBox.

    Declaration
    public CheckBoxAdvBackStyle BackgroundStyle { get; set; }
    Property Value
    Type Description
    CheckBoxAdvBackStyle

    BeforeTouchSize

    Gets or sets Control size before the touch mode is enabled.

    Declaration
    public Size BeforeTouchSize { get; set; }
    Property Value
    Type Description
    System.Drawing.Size

    Border3DStyle

    Gets or sets the 3Dborder style of the checkbox.

    Declaration
    public Border3DStyle Border3DStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.Border3DStyle

    BorderColor

    Gets or sets the color of the border.

    Declaration
    public Color BorderColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    BorderSingle

    Gets or sets the style of the border when BorderStyles is FixedSingle.

    Declaration
    public ButtonBorderStyle BorderSingle { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.ButtonBorderStyle
    Remarks

    By default it`s value is Solid.

    BorderStyle

    Gets or sets the style of the border.It can be None, 3D and 2D.

    Declaration
    public BorderStyle BorderStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.BorderStyle
    Remarks

    By default it`s value is Fixed3D.

    CanApplyTheme

    Gets or sets a value indicating whether a SkinManager theme settings can be applied to the control.

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

    The default value is true.

    Remarks

    This property must be initialized before applying the VisualTheme />

    CanOverrideStyle

    Gets or sets a value indicating whether control elements styles can be overridden by theme style settings.

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

    Default value is false.

    Remarks

    By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. This property should be enabled or disabled before calling the ThemeName property of the control.

    CheckAlign

    Gets or sets the checkbox alignment.

    Declaration
    public ContentAlignment CheckAlign { get; set; }
    Property Value
    Type Description
    System.Drawing.ContentAlignment

    CheckedImage

    Gets or sets the image used to draw the checkbox when checked and mouse not over.

    Declaration
    public Image CheckedImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    CheckedInt

    Gets or sets for the checked state.

    Declaration
    public int CheckedInt { get; set; }
    Property Value
    Type Description
    System.Int32

    CheckedString

    Gets or sets for the checked state.

    Declaration
    public string CheckedString { get; set; }
    Property Value
    Type Description
    System.String

    ControlName

    Gets the name of the control.

    Declaration
    public string ControlName { get; }
    Property Value
    Type Description
    System.String

    DefaultSize

    Declaration
    protected override Size DefaultSize { get; }
    Property Value
    Type Description
    System.Drawing.Size

    DisabledImage

    Gets or sets the image used to draw the checkbox when disabled.

    Declaration
    public Image DisabledImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    DrawFocusRectangle

    Gets or sets a value indicating whether the focus rectangle is visible when it gets the focus.

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

    EnableTouchMode

    Gets or sets the touchmode for the contol.

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

    GradientEnd

    Gets or sets the end color of the gradient of the background of the control.

    Declaration
    public Color GradientEnd { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    GradientStart

    Gets or sets the start color of the gradient of the background of the control.

    Declaration
    public Color GradientStart { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    HotBorderColor

    Gets or sets the color of the FixedSingle border when mouse over.

    Declaration
    public Color HotBorderColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ImageCheckBox

    Gets or sets a value indicating whether the checkbox will be drawn using the images provided.

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

    ImageCheckBoxSize

    Gets or sets the Image checkbox size.

    Declaration
    public Size ImageCheckBoxSize { get; set; }
    Property Value
    Type Description
    System.Drawing.Size

    MouseOverCheckedImage

    Gets or sets the image used to draw the checkbox when checked and mouse over.

    Declaration
    public Image MouseOverCheckedImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    MouseOverUncheckedImage

    Gets or sets the image used to draw the checkbox when unchecked and mouse over.

    Declaration
    public Image MouseOverUncheckedImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    ShadowColor

    Gets or sets the color of the text shadow.

    Declaration
    public Color ShadowColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ShadowOffset

    Gets or sets the offset of the text shadow.

    Declaration
    public Point ShadowOffset { get; set; }
    Property Value
    Type Description
    System.Drawing.Point

    StretchImage

    Gets or sets a value indicating whether the state images of the CheckBox are stretched.

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

    TextAlignment

    Gets or sets the alignment of the text. WrapText must be set to false.

    Declaration
    [Obsolete]
    public TextAlignment TextAlignment { get; set; }
    Property Value
    Type Description
    TextAlignment

    TextContentAlignment

    Gets or sets the alignment of the text. WrapText must be set to false.

    Declaration
    public ContentAlignment TextContentAlignment { get; set; }
    Property Value
    Type Description
    System.Drawing.ContentAlignment

    TextShadow

    Gets or sets a value indicating whether the text shadow is visible.

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

    ThemeName

    Gets or sets the theme name of the control.

    Declaration
    public string ThemeName { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null.

    Remarks

    This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

    UncheckedImage

    Gets or sets the image used to draw the checkbox when unchecked and mouse not over.

    Declaration
    public Image UncheckedImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    UncheckedInt

    Gets or sets for the unchecked state.

    Declaration
    public int UncheckedInt { get; set; }
    Property Value
    Type Description
    System.Int32

    UncheckedString

    Gets or sets for the unchecked state.

    Declaration
    public string UncheckedString { get; set; }
    Property Value
    Type Description
    System.String

    UseGDITextRendering

    Gets or sets a value indicating whether GDI Text renderer in RadioButton or not.

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

    UseMnemonic

    Gets or sets a value indicating whether the first character that is proceeded by an ampersand is used as the mnemonic key of the control.

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

    WrapText

    Gets or sets a value indicating whether the text in the CheckBox is wrapped.

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

    Methods

    ApplyScaleToControl(Single)

    Applies the scaling for the control.

    Declaration
    public void ApplyScaleToControl(float scaleFactor)
    Parameters
    Type Name Description
    System.Single scaleFactor

    Dispose(Boolean)

    Cleans up any resources being used.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    GetActiveThemeName()

    Gets the active theme name of the control.

    Declaration
    public override string GetActiveThemeName()
    Returns
    Type Description
    System.String

    Returns the active theme name.

    Overrides
    BaseControl.GetActiveThemeName()

    GetPreferredSize(Size)

    Overridden. Represents to calculate the default height based on the text height and padding values (top and bottom paddings).

    Declaration
    public override Size GetPreferredSize(Size proposedSize)
    Parameters
    Type Name Description
    System.Drawing.Size proposedSize
    Returns
    Type Description
    System.Drawing.Size

    IsInputKey(Keys)

    Overridden IsInputKey.

    Declaration
    protected override bool IsInputKey(Keys keyData)
    Parameters
    Type Name Description
    System.Windows.Forms.Keys keyData

    Keys data that contains the event data.

    Returns
    Type Description
    System.Boolean

    Return bool property.

    OnEnabledChanged(EventArgs)

    Overridden OnenableChanged

    Declaration
    protected override void OnEnabledChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnEnter(EventArgs)

    Overridden OnEnter.

    Declaration
    protected override void OnEnter(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnFontChanged(EventArgs)

    Overridden OnFontChanged

    Declaration
    protected override void OnFontChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnHandleCreated(EventArgs)

    Overridden OnHandleCreated.

    Declaration
    protected override void OnHandleCreated(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnHandleDestroyed(EventArgs)

    Overridden OnHandleDestroyed.

    Declaration
    protected override void OnHandleDestroyed(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnKeyDown(KeyEventArgs)

    Overridden OnKeyDown.

    Declaration
    protected override void OnKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.KeyEventArgs e

    KeyEventArgs KeyEventArgs

    OnLeave(EventArgs)

    Overridden OnLeave.

    Declaration
    protected override void OnLeave(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnMouseDown(MouseEventArgs)

    Overridden. SeeSystem.Windows.Forms.Control.OnMouseDown(System.Windows.Forms.MouseEventArgs).

    Declaration
    protected override void OnMouseDown(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.MouseEventArgs e

    MouseEventArgs that contains event data.

    OnMouseEnter(EventArgs)

    Overridden OnMouseEnter.

    Declaration
    protected override void OnMouseEnter(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnMouseLeave(EventArgs)

    Overridden OnMouseLeave.

    Declaration
    protected override void OnMouseLeave(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnMouseUp(MouseEventArgs)

    Overridden. System.Windows.Forms.Control.OnMouseUp(System.Windows.Forms.MouseEventArgs)

    Declaration
    protected override void OnMouseUp(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.MouseEventArgs e

    MouseEventArgs that contains the event data.

    OnPaint(PaintEventArgs)

    On paint method

    Declaration
    protected override void OnPaint(PaintEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e

    Paint event Argument

    OnRightToLeftChanged(EventArgs)

    Overridden OnRightToLeftChanged.

    Declaration
    protected override void OnRightToLeftChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnSizeChanged(EventArgs)

    Overrriden OnSizeChanged .

    Declaration
    protected override void OnSizeChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnTextChanged(EventArgs)

    Overridden OnTextChanged.

    Declaration
    protected override void OnTextChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnThemeChanged(EventArgs)

    Ovridden OnThemechanged.

    Declaration
    protected override void OnThemeChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    Overrides
    ThemedControl.OnThemeChanged(EventArgs)

    RaiseThemeChanged(Object, ThemeChangedEventArgs)

    Raises the ThemeNameChanged event when theme name changed.

    Declaration
    protected override void RaiseThemeChanged(object sender, ThemeChangedEventArgs args)
    Parameters
    Type Name Description
    System.Object sender

    The sender value.

    ThemeChangedEventArgs args

    A ThemeChangedEventArgs contains the event data.

    Overrides
    BaseControl.RaiseThemeChanged(Object, ThemeChangedEventArgs)

    RecalculatePositions()

    Declaration
    protected void RecalculatePositions()

    ResetAutoSize()

    Represents to reset the AutoSize property.

    Declaration
    public void ResetAutoSize()

    ShouldSerializeAutoSize()

    Represents to serialize the AutoSize property.

    Declaration
    public bool ShouldSerializeAutoSize()
    Returns
    Type Description
    System.Boolean

    Events

    ThemeNameChanged

    Occurs when theme name of the control has changed.

    Declaration
    public event ThemeChangedEventHandler ThemeNameChanged
    Event Type
    Type Description
    ThemeChangedEventHandler

    Explicit Interface Implementations

    IVisualStyle.VisualTheme

    Gets or sets the VisualTheme of the control.

    Declaration
    string IVisualStyle.VisualTheme { get; set; }
    Returns
    Type Description
    System.String

    IThemeProvider.BaseThemeName

    Gets or sets the Base Theme name of the theme

    Declaration
    string IThemeProvider.BaseThemeName { get; set; }
    Returns
    Type Description
    System.String

    Implements

    System.IDisposable
    System.Windows.Forms.IMessageFilter
    IThemeProvider
    IVisualStyle
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved