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.

<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; }
    }
}

Properties

Name Type Description Notes Default Value
property icon Checked Boolean? Gets or sets whether the control is checked.
attribute
inner element
static value
bindable
default
False
property icon 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
property icon 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
property icon 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
property icon FormControlStyle CheckboxStyle Gets or sets whether the control should use default or custom style.
attribute
inner element
static value
bindable
default
Default
property icon IsInline Boolean Gets or sets whether there are more checkBoxes on the same line.
attribute
inner element
static value
bindable
default
False
property icon 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
property icon 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
property icon Text String Gets or sets the label text that is rendered next to the control.
attribute
inner element
static value
bindable
default
property icon TextOrContentCapability TextOrContentCapability
attribute
inner element
static value
bindable
default
null

Events

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

HTML produced by the control