Class CheckBoxAdv

The CheckBoxAdv control is an alternative to the .Net CheckBox control. It has a very customizable border and background and supports advanced DataBinding.

Inheritance
System.Object
BaseControl
ThemedControl
CheckRadioBase
CheckBoxAdv
Implements
System.IDisposable
System.Windows.Forms.IMessageFilter
System.ComponentModel.ISupportInitialize
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class CheckBoxAdv : CheckRadioBase, IDisposable, IMessageFilter, IThemeProvider, IVisualStyle, ISupportInitialize

Constructors

CheckBoxAdv()

Initializes a new instance of the CheckBoxAdv class.

Declaration
public CheckBoxAdv()

Properties

AccessibilityEnabled

Gets or sets a value indicating whether the control should enable its Accessibility support.

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

AutoCheck

Gets or sets a value indicating whether the CheckBox to automatically change state when clicked.

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

BackColor

Gets or sets BackColor of CheckBoxAdv.

Declaration
public override Color BackColor { get; set; }
Property Value
Type
System.Drawing.Color

BoolValue

Gets or sets a value indicating whether the Boolvalue is true or false Used for data-binding.

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

Checked

Gets or sets a value indicating whether checked state of the CheckBox is checked or not.

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

CheckState

Gets or sets the check state of the CheckBox.

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

Font

Gets or sets the Font of the CheckBoxAdv.

Declaration
public override Font Font { get; set; }
Property Value
Type
System.Drawing.Font

IndeterminateImage

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

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

IndeterminateInt

Gets or sets the integer value used when indeterminate.

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

IndeterminateString

Gets or sets the indeterminate string.

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

IntValue

Gets or sets the int value.

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

IsVisualStyleEnabled

Gets a value indicating whether the visual style based theme is applied to the control. This also indicates whether the theme files are referred from external assemblies or not.

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

Return true, if the visual style based theme is applied to control. Otherwise returns false.

MetroColor

Gets or sets the theme color of the CheckboxAdv.

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

MouseOverIndetermImage

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

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

Office2007ColorScheme

Gets or sets office 2007 color scheme.

Declaration
public Office2007Theme Office2007ColorScheme { get; set; }
Property Value
Type
Office2007Theme

Office2007ColorTable

Gets color table for Office2007 visual style.

Declaration
protected Office2007Colors Office2007ColorTable { get; }
Property Value
Type
Office2007Colors

Office2010ColorScheme

Gets or sets office 2010 color scheme.

Declaration
public Office2010Theme Office2010ColorScheme { get; set; }
Property Value
Type
Office2010Theme

Office2010ColorTable

Gets color table for Office2010 visual style.

Declaration
protected Office2010Colors Office2010ColorTable { get; }
Property Value
Type
Office2010Colors

ReadOnlyMode

Gets or sets a value indicating whether the read only mode of the CheckBox is set.

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

StringValue

Gets or sets the string value.

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

Style

Gets or sets an advanced appearance for the checkBoxAdv.

Declaration
public CheckBoxAdvStyle Style { get; set; }
Property Value
Type
CheckBoxAdvStyle

Text

Gets or sets the Text of the CheckBoxAdv.

Declaration
public override string Text { get; set; }
Property Value
Type
System.String

ThemeStyle

Gets or sets the value used to customize the appearance of the CheckBoxAdv.

Declaration
public TickControlVisualStyle ThemeStyle { get; set; }
Property Value
Type
TickControlVisualStyle
Remarks

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

Tristate

Gets or sets a value indicating whether undetermined state can be accessed through clicking.

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

UseGDITextRendering

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

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

Methods

BeginInit()

Signals the object that initialization is starting.

Declaration
public void BeginInit()

CreateAccessibilityInstance()

Overridden to update the accessibility object for the CheckBoxAdv.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type Description
System.Windows.Forms.AccessibleObject

Returns the accessibility object for the CheckBoxAdv.

Dispose(Boolean)

Cleans up any resources being used.

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

EndInit()

Signals the object that initialization is complete.

Declaration
public void EndInit()

GetControlName(String)

Helps to apply the ControlName settings in control

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName

ControlName
Returns
Type
System.String
Overrides

OnCanApplyThemeChanged(Boolean)

Helps to apply the CanApplyTheme settings in control

Declaration
public override void OnCanApplyThemeChanged(bool canApplyTheme)
Parameters
Type Name Description
System.Boolean canApplyTheme
Overrides

OnCanOverrideStyleChanged(Boolean)

Helps to apply the CanOverriderStyle settings in control

Declaration
public override void OnCanOverrideStyleChanged(bool canOverriderStyle)
Parameters
Type Name Description
System.Boolean canOverriderStyle
Overrides

OnCheckedChanged(CheckedChangedEventArgs)

Raises when Check property of the checkbox changes.

Declaration
protected virtual void OnCheckedChanged(CheckedChangedEventArgs e)
Parameters
Type Name Description
CheckedChangedEventArgs e

EventArgs that contains the event data.

OnCheckStateChanged(EventArgs)

Raises the CheckStateChanged event.

Declaration
protected virtual void OnCheckStateChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.EventArgs instance containing the event data.

OnClick(EventArgs)

Raises the Clicked event.

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

The System.EventArgs instance containing the event data.

OnEnabledChanged(EventArgs)

Raises the EnabledChanged event.

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

The System.EventArgs instance containing the event data.
Overrides
Remarks

Overridden

OnHandleCreated(EventArgs)

Overrideen for raises when handle created.

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

EventArgs that contains the event data.
Overrides

OnKeyDown(KeyEventArgs)

Raises when key down

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

EventArgs that contains the event data.
Overrides

OnMouseDown(MouseEventArgs)

Raises the MouseDown event.

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

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Overrides

OnMouseEnter(EventArgs)

Raises the MouseEnter event.

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

The System.EventArgs instance containing the event data.
Overrides

OnMouseUp(MouseEventArgs)

Raises the MouseUp event.

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

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Overrides
Remarks

Overridden

OnPaint(PaintEventArgs)

Raises the paint event.

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

The System.Windows.Forms.PaintEventArgs instance containing the event data.
Overrides
Remarks

Overriden

OnThemeNameChanged(String)

Helps to apply the ThemeName settings in control

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName

ThemeName
Overrides

ProcessMnemonic(Char)

Processes a mnemonic character.

Declaration
protected override bool ProcessMnemonic(char charCode)
Parameters
Type Name Description
System.Char charCode

The character to process.
Returns
Type Description
System.Boolean

true depending on CheckState.

Events

BoolValueChanged

Occurs when the BoolValue property is changed in CheckBoxAdv.

Declaration
public event EventHandler BoolValueChanged
Event Type
Type
System.EventHandler

CheckedChanged

Occurs when the Checked property is changed in CheckBoxAdv.

Declaration
public event EventHandler CheckedChanged
Event Type
Type
System.EventHandler

CheckStateChanged

Occurs when the CheckState property is changed in CheckBoxAdv.

Declaration
public event EventHandler CheckStateChanged
Event Type
Type
System.EventHandler

Implements

System.IDisposable
System.Windows.Forms.IMessageFilter
System.ComponentModel.ISupportInitialize