Edit on Github

FormControlCheckBox

in namespace DotVVM.Bootstrap5.Controls

Extends the CheckBox control for usage in Form.

Usage & Scenarios

A special version of the CheckBox control that can be used in Form.

See CheckBox for more info on how to use this control.

https://getbootstrap.com/docs/5.2/forms/form-control

<bs:FormControlCheckBox HelpText="Let us know if you like potatoes" Text="I like potatoes" VisualStyle="Switch" Checked="{value: Value}" />

<bs:FormControlCheckBox Text="Check this" VisualStyle="Default" CheckedValue="1" CheckedItems="{value: ResultItems}" />

<bs:Button Text="Validate" Click="{command: Validate()}" />

using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;

public class ViewModel : DotvvmViewModelBase, IValidatableObject
{
    public bool Value { get; set; }

    public List<string> ResultItems { get; set; } = new List<string>();

    public void Validate()
    {

    }

    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        if (!Value)
        {
            yield return new ValidationResult($"Value must be true.", new[] { nameof(Value) });
        }

        if (!ResultItems.Any())
        {
            yield return new ValidationResult($"At least one checkbox must be checked", new[] { nameof(ResultItems) });
        }
    }
}

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 a single CheckBox control, that is validated.	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
FormControlCssClass	String	Gets or sets the CSS class to apply to the form control element.	attribute inner element static value bindable default	null
HelpContent	List<DotvvmControl>	Gets or sets a custom template for for the help text. Cannot be combined with a `HelpText` property.	attribute inner element static value bindable default	null
HelpText	String	Gets or sets a plain text for the help text. Cannot be combined with a `HelpContent` property.	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.