Edit on Github

CheckBox

in namespace DotVVM.Framework.Controls.Bootstrap4

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/4.3/components/forms/#checkboxes-and-radios

Sample 1: Inline CheckBoxes

The IsInline property allows to render checkboxes on one row.

Use the FormControlStyle property to choose between browser default theme and Bootstrap custom theme.

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>

using DotVVM.Framework.ViewModel;

namespace DotvvmWeb.Views.Docs.Controls.bootstrap.CheckBox.sample1
{
    public class ViewModel : DotvvmViewModelBase
    {
        public bool Checked1 { get; set; }
        public bool Checked2 { get; set; }
    }
}

Show all inherited properties

Properties

Name	Type	Description	Notes	Default Value
Checked	Boolean?	Gets or sets whether the control is checked.	attribute inner element static value bindable default	False
CheckedItems	IEnumerable	Gets or sets a collection of values of all checked checkboxes. 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
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
DisableIndeterminate	Boolean	When set to true, `null` in the Checked property will be treated as `false`, instead of marking the checkbox as indeterminate	attribute inner element static value bindable default	False
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	True
FormControlStyle	CheckboxStyle	Gets or sets whether the control should use default or custom style.	attribute inner element static value bindable default	Default
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
InnerText	String	Gets or sets the inner text of the HTML element. Note that this property can only be used on HtmlGenericControl directly and when the control does not have any children.	attribute inner element static value bindable default	null
InputCssClass	String	Gets or sets a CSS class that will be appended on the rendered input element.	attribute inner element static value bindable default	null
IsInline	Boolean	Gets or sets whether there are more checkBoxes on the same line.	attribute inner element static value bindable default	False
ItemKeyBinding	IValueBinding	Gets or sets a property that retrieves an unique key for the CheckedValue so it can be compared with objects in the CheckedItems collection. This property must be set if the value of the CheckedValue property is not a primitive type.	attribute inner element static value bindable default	null
LabelCssClass	String	Gets or sets a CSS class that will be appended on the rendered label element.	attribute inner element static value bindable default	null
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	null
Text	String	Gets or sets the label text that is rendered next to the control.	attribute inner element static value bindable default
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

Events

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