CheckBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • ButtonBase
    • CheckBox

Represents a check box control.

C#

public class CheckBox : ButtonBase, IReadOnly, IValidation

VB.NET

Public Class CheckBox
    Inherits ButtonBase
    Implements IReadOnly, IValidation

Constructors

CheckBox()

Initializes a new instance of the CheckBox class.

CheckBox(text, onCheckedChanged)

Initializes a new instance of the CheckBox class.

Name	Type	Description
text	String	Initial text.
onCheckedChanged	Action<Object, EventArgs>	Optional CheckedChanged handler.

CheckBox(text, location, size, onCheckedChanged)

Initializes a new instance of the CheckBox class.

Name	Type	Description
text	String	Initial text.
location	Point	Initial location.
size	Size	Initial size.
onCheckedChanged	Action<Object, EventArgs>	Optional CheckedChanged handler.

Properties

Appearance

Appearance: Returns or sets the value that determines the appearance of a CheckBox control. (Default: Normal)

AutoCheck

Boolean: Returns or set a value indicating whether the Checked or CheckState values and the CheckBox's appearance are automatically changed when the CheckBox is clicked. (Default: True)

AutoSize

Boolean: Returns or sets a value that indicates whether the control resizes based on its contents. (Default: True)

AutoToolTip

Boolean: Returns or sets whether a tooltip is displayed when the text extends beyond the size of the control. (Default: False)

The auto tooltip is set on the browser using the title attribute managed by the browser, does not use the themed tooltip managed by Wisej.NET.

CheckAlign

ContentAlignment: Returns or sets the horizontal and vertical alignment of the check mark on a CheckBox control. (Default: MiddleLeft)

Checked

Boolean: Returns or set a value indicating whether the CheckBox is in the checked state. (Default: False)

CheckedForeColor

Color: Returns or sets the text color used when the CheckBox is checked. (Default: Color [Empty])

CheckState

CheckState: Returns or sets the state of the CheckBox. (Default: Unchecked)

DefaultSize

Size: Returns the default size of the control.

Invalid

Boolean: Returns or sets a value that indicates that the control is invalid.

InvalidMessage

String: Returns or sets the invalid message that is shown in the invalid tooltip. (Default: "")

ReadOnly

Boolean: Returns or sets whether the control is read-only. (Default: False)

TextAlign

ContentAlignment: Returns or sets the alignment of the text on the CheckBox control. (Default: MiddleLeft)

ThreeState

Boolean: Returns or sets whether the CheckBox will allow three check states rather than two. (Default: False)

Methods

OnAppearanceChanged(e)

Fires the AppearanceChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnCheckedChanged(e)

Fires the CheckedChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnCheckStateChanged(e)

Fires the CheckStateChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnClick(e)

Fires the Click event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnForeColorChanged(e)

Fires the ForeColorChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnReadOnlyChanged(e)

Fires the ReadOnlyChanged event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnValidating(e)

Fires the Validating event.

Parameter	Type	Description
e	CancelEventArgs	A EventArgs that contains the event data.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

PerformClick()

Generates a Click event for a CheckBox.

Events

AppearanceChanged

EventHandler Fired when the value of the Appearance property changes.

CheckedChanged

EventHandler Fired when the value of the Checked property changes.

CheckStateChanged

EventHandler Fired when the value of the CheckState property changes.

ReadOnlyChanged

EventHandler Fired when the value of the ReadOnly property has changed.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
ICommandSource	Defines an object that can invoke a Command.
IDropTarget	Controls that support drag & drop operations implement this interface.
IImage	Provides access to common image properties across the controls that implement this interface.
IReadOnly	Provides access to the ReadOnly property for coontrols that support the read-only mode.
IValidation	Provides access to the validation events and properties property for controls that support validation.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.