CheckBox - ahatornn/clforms GitHub Wiki
ClForms.Elements.CheckBox
Represents a control to give the user an option, such as true/false or yes/no
public class CheckBox: ButtonBase, IElementStyle<CheckBox>Inheritance Control -> BaseFocusableControl -> ButtonBase -> Button
Derived IElementStyle<CheckBox>
The following code example creates a CheckBox, sets its Text property to "Click me", and adds event handler OnCheckedChanged
var cb1 = new CheckBox("Click me");
cb1.OnCheckedChanged += CheckedChanged;
panel1.AddContent(cb1);
…
private void CheckedChanged(object sender, PropertyChangedEventArgs<bool> e)
{
// put your business logic here
}You can find more examples of using the CheckBox in this project
A CheckBox can be clicked by using ENTER key, or SPACEBAR if the ChackBox has focus.
The Background property as default equals Color.NotSet value (transparent). The Foreground property as default equals Application.SystemColors.ButtonText value. All values defined in DefaultSystemColors.
The ThreeState property determines whether the control supports two or three states. Use the Checked property to get or set the value of a two-state CheckBox control and use the CheckState property to get or set the value of a three-state CheckBox control.
If the ThreeState property is set to true, the Checked property will return true for either a checked or indeterminate state.
| Syntax | Description |
|---|---|
| CheckBox() | Initialize a new CheckBox instance |
| CheckBox(string text) | Initialize a new CheckBox instance with specified text |
| Name | Type | Description |
|---|---|---|
| AutoSize | bool | Gets or sets a value indicating whether the control is resized in accordance with its contents |
| Background | Color | Gets or sets a brush that describes the background of a control |
| BackgroundIsTransparent | bool | Gets a value indicating whether the Background has Color.NotSet
|
| Bounds | Rect | Gets the size and location of the control including its nonclient elements, in points, relative to the parent control |
| CheckState | CheckState | Gets or sets the state of the CheckBox |
| Checked | bool | Gets or set a value indicating whether the CheckBox is in the checked state |
| DesiredSize | Size | Gets the size that this element computed during the measure pass of the layout process |
| DisabledBackground | Color | Gets or sets a value to display of background when the control is disabled |
| DisabledForeground | Color | Gets or sets a value to display of text color when the control is disabled |
| DrawingContext | IDrawingContext | Gets a value of the drawing context |
| FocusBackground | Color | Focused component background color |
| FocusForeground | Color | Focused component text color |
| Foreground | Color | Gets or sets a brush that describes the text of a control |
| ForegroundIsTransparent | bool | Gets a value indicating whether the Foreground has Color.NotSet
|
| Height | int? | Gets or sets the height of the control |
| Id | long | Gets a value of the control's identifier |
| IsDisabled | bool | Gets or sets a value indicating whether the control cannot respond to user interaction |
| IsFocus | bool | Gets or sets focus value of component |
| IsMeasureValid | bool | Gets a value indicating whether component sizing was performed |
| IsVisualValid | bool | Gets a value indicating whether the component is being re-rendered |
| Location | Point | Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container |
| Margin | Thickness | Gets or sets the outer margin of an element |
| Padding | Thickness | Gets or sets a Thickness value that describes the amount of space between a control and its child element |
| Parent | ContentControl | Gets or sets the parent container of the control |
| TabIndex | int | Gets or sets the sequence for moving the TAB key between the controls inside the container |
| TabStop | bool | Gets or sets a value indicating whether the user can focus on the given control using the TAB key |
| Tag | object | Gets or sets the object that contains data about the control |
| Text | string | Gets or sets the text associated with this control |
| TextAlignment | TextAlignment | Gets or sets the horizontal alignment of the contents of the text |
| ThreeState | bool | Gets or sets a value indicating whether the CheckBox will allow three check states rather than two |
| Width | int? | Gets or sets the width of the control |
| WordWrap | bool | Indicates whether a multiline text box control automatically wraps words to the beginning of the next line when necessary |
| Syntax | Description |
|---|---|
| Arrange(Rect) | Positions child elements and determines a size for a Control. Parent elements call this method from their Arrange(Rect) implementation to form a recursive layout update |
| CanFocus() | Indicates whether component focus can be set |
| InputAction(ConsoleKeyInfo) | Handles a keystroke |
| InvalidateMeasure() | Invalidates the measurement state (layout) for the element |
| InvalidateMeasureIfAutoSize() | Invalidates the measurement state (layout) for the element if AutoSize property is true otherwise invalidates the rendering of the element |
| InvalidateVisual() | Invalidates the rendering of the element, and forces a complete new layout pass. OnRender(IDrawingContext) is called after the layout cycle is completed |
| Measure(Size) | Updates DesiredSize of a Control. Parent elements call this method from their own Measure(Size) implementations to form a recursive layout update |
| OnRender(IDrawingContext) | Filling a pseudographics drawing context |
| ParentWindow() | Gets the form the control is in |
| SetFocus() | Sets input focus to current item |
| SetStyle(Action) | Defines actions with an element style |
| Event | Description |
|---|---|
| OnAutoSizeChanged | Occurs when the value of the AutoSize property changes |
| OnBackgroundChanged | Occurs when the value of the Background property changes |
| OnCheckStateChanged | Occurs when the value of the CheckState property changes |
| OnCheckedChanged | Occurs when the value of the Checked property changes |
| OnClick | Occurs when the ButtonBase control is clicked |
| OnDisabledBackgroundChanged | Occurs when the value of the DisabledBackground property changes |
| OnDisabledChanged | Occurs when the value of the IsDisabled property changes |
| OnDisabledForegroundChanged | Occurs when the value of the DisabledForeground property changes |
| OnEnter | Input focus event |
| OnFocusBackgroundChanged | Occurs when the value of the FocusBackground property changes |
| OnFocusChanged | Occurs when the value of the IsFocus property changes |
| OnFocusForegroundChanged | Occurs when the value of the FocusForeground property changes |
| OnForegroundChanged | Occurs when the value of the Foreground property changes |
| OnHeightChanged | Occurs when the value of the Height property changes |
| OnLeave | Input focus loss event |
| OnMarginChanged | Occurs when the value of the Margin property changes |
| OnPaddingChanged | Occurs when the value of the Padding property changes |
| OnParentChanged | Occurs when the value of the Parent property changes |
| OnTabIndexChanged | Occurs when a property value of TabIndex changes |
| OnTabStopChanged | Occurs when a property value of TabStop changes |
| OnTagChanged | Occurs when the value of the Tag property changes |
| OnTextAlignmentChanged | Occurs when the value of the TextAlignment property changes |
| OnTextChanged | Occurs when the value of the Text property changes |
| OnThreeStateChanged | Occurs when the value of the ThreeState property changes |
| OnWidthChanged | Occurs when the value of the Width property changes |
| OnWordWrapChanged | Occurs when the value of the WordWrap property changes |