Edit on Github

CheckBox

in namespace DotVVM.Bootstrap5.Controls

Extends the default CheckBox control with additional Bootstrap features.

Usage & Scenarios

Extends the builtin CheckBox control with Bootstrap CSS styles.

If you want to use this control inside ButtonGroup, use ButtonGroupCheckBox instead.

https://getbootstrap.com/docs/5.2/forms/checks-radios

Sample 1: Inline CheckBoxes

The IsInline property allows to render checkboxes on one row.

Use the RenderLabel property to set whether the label should be rendered. If not set, the label will be rendered only when needed.

page.dothtml
ViewModel.cs

<bs:CheckBox Text="CheckBox default" Checked="{value: Checked1}" IsInline="true" />
<bs:CheckBox Text="CheckBox bootstrap custom" Checked="{value: Checked2}" FormControlStyle="BootstrapCustom" IsInline="true" />

<p>CheckBox 1: {{value: Checked1}}</p>
<p>CheckBox 2: {{value: Checked2}}</p>

public class ViewModel : DotvvmViewModelBase
{
    public bool Checked1 { get; set; }
    public bool Checked2 { get; set; }
}

Sample 2: Checkbox VisualStyle

Except the Default radio button visual style, there are Switch and Button visual styles.

page.dothtml
ViewModel.cs

<h2>Button type</h2>
<bs:Checkbox Checked="{value: true}" Text="Primary" VisualStyle="Button" ButtonType="Primary" IsInline="true" />
<bs:Checkbox Checked="{value: true}" Text="Secondary" VisualStyle="Button" ButtonType="Secondary" ButtonVisualStyle="Outline" IsInline="true" />
<bs:Checkbox Checked="{value: true}" Text="Danger" VisualStyle="Button" ButtonType="Danger" ButtonFontType="Warning" ButtonSize="Small" IsInline="true" />
<hr />
<h2>Switch type</h2>
<bs:Checkbox Checked="{value: true}"  VisualStyle="Switch" Text="Switch RadioButton"/>
<hr />

Show all inherited properties

Properties

Name	Type	Description	Notes	Default Value
ButtonFontType	ButtonTextColor	Gets or sets the font color. Use this property in combination with a `Button` checkbox visual style.	attribute inner element static value bindable default	Default
ButtonSize	Size	Gets or sets the button size. Use this property in combination with a `Button` checkbox visual style.	attribute inner element static value bindable default	Default
ButtonType	ButtonType	Gets or sets the button type. Use this property in combination with a `Button` checkbox visual style.	attribute inner element static value bindable default	Primary
ButtonVisualStyle	ButtonVisualStyle	Gets or sets the button visual style. Use this property in combination with a `Button` checkbox visual style.	attribute inner element static value bindable default	SolidFill
Checked	Boolean?	Gets or sets whether the control is checked.	attribute inner element static value bindable default	null
CheckedItems	IValueBinding<IEnumerable>	Gets or sets the collection of checked items. Use this property in combination with the CheckedValue property.	attribute inner element static value bindable default	null
CheckedValue	Object	Gets or sets the value that will be used as a result when the control is checked. Use this property in combination with the CheckedItem or CheckedItems property.	attribute inner element static value bindable default	null
ClientIDMode	ClientIDMode	Gets or sets the client ID generation algorithm.	attribute inner element static value bindable default	Static
Content	List<DotvvmControl>	Gets or sets the content placed inside the control.	attribute inner element static value bindable default	null
DataContext	Object	Gets or sets a data context for the control and its children. All value and command bindings are evaluated in context of this value. The DataContext is null in client-side templates.	attribute inner element static value bindable default	null
Enabled	Boolean	Gets or sets a value indicating whether the control is enabled and can be clicked on.	attribute inner element static value bindable default	null
ID	String	Gets or sets the control client ID within its naming container.	attribute inner element static value bindable default	null
IncludeInPage	Boolean	Gets or sets whether the control is included in the DOM of the page.	attribute inner element static value bindable default	True
IsInline	Boolean	Gets or sets whether the control should be rendered on the same horizontal row.	attribute inner element static value bindable default	False
IsReversed	Boolean	Gets or sets whether the control should be put on the opposite side of the page.	attribute inner element static value bindable default	False
RenderLabel	Boolean	Gets or sets whether the label will be rendered. If set to null than the label will be rendered if needed.	attribute inner element static value bindable default	True
Text	String	Gets or sets the text inside the control.	attribute inner element static value bindable default	null
Visible	Boolean	Gets or sets whether the control is visible. When set to false, `style="display: none"` will be added to this control.	attribute inner element static value bindable default	True
VisualStyle	CheckBoxVisualStyle	Gets or sets the radio button visual style. Possible values are `Default`, `Switch`, `Button`.	attribute inner element static value bindable default	Default

Events

	Name	Type	Description
	Changed	ICommandBinding	Gets or sets the command that will be triggered when the control check state is changed.