Class RadzenCheckBoxList<TValue>
A checkbox group component that allows users to select multiple options from a list of choices. RadzenCheckBoxList displays multiple checkboxes with configurable layout, orientation, and data binding, binding to a collection of selected values.
Inherited Members
Namespace: Radzen.Blazor
Assembly: Radzen.Blazor.dll
Syntax
public class RadzenCheckBoxList<TValue> : FormComponent<IEnumerable<TValue>>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IRadzenFormComponent
Type Parameters
| Name | Description |
|---|---|
| TValue | The type of individual item values. The bound Value is IEnumerable<TValue> containing all selected items. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
Examples
Static checkbox list:
<RadzenCheckBoxList @bind-Value=@selectedOptions TValue="string">
<Items>
<RadzenCheckBoxListItem Text="Email notifications" Value="email" />
<RadzenCheckBoxListItem Text="SMS notifications" Value="sms" />
<RadzenCheckBoxListItem Text="Push notifications" Value="push" />
</Items>
</RadzenCheckBoxList>
@code {
IEnumerable<string> selectedOptions = new[] { "email" };
}
Data-bound checkbox list:
<RadzenCheckBoxList @bind-Value=@selectedIds TValue="int" Data=@categories
TextProperty="Name" ValueProperty="Id" Orientation="Orientation.Horizontal" />
Constructors
RadzenCheckBoxList()
A checkbox group component that allows users to select multiple options from a list of choices. RadzenCheckBoxList displays multiple checkboxes with configurable layout, orientation, and data binding, binding to a collection of selected values.
Declaration
public RadzenCheckBoxList()
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
Examples
Static checkbox list:
<RadzenCheckBoxList @bind-Value=@selectedOptions TValue="string">
<Items>
<RadzenCheckBoxListItem Text="Email notifications" Value="email" />
<RadzenCheckBoxListItem Text="SMS notifications" Value="sms" />
<RadzenCheckBoxListItem Text="Push notifications" Value="push" />
</Items>
</RadzenCheckBoxList>
@code {
IEnumerable<string> selectedOptions = new[] { "email" };
}
Data-bound checkbox list:
<RadzenCheckBoxList @bind-Value=@selectedIds TValue="int" Data=@categories
TextProperty="Name" ValueProperty="Id" Orientation="Orientation.Horizontal" />
Properties
AlignItems
Gets or sets the items alignment.
Declaration
[Parameter]
public AlignItems AlignItems { get; set; }
Property Value
| Type | Description |
|---|---|
| AlignItems | The items alignment. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
AllowSelectAll
Gets or sets a value indicating whether the user can select all values. Set to false by default.
Declaration
[Parameter]
public bool AllowSelectAll { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
|
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
Data
Gets or sets the data used to generate items.
Declaration
[Parameter]
public virtual IEnumerable Data { get; set; }
Property Value
| Type | Description |
|---|---|
| IEnumerable | The data. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
DisabledProperty
Gets or sets the disabled property.
Declaration
[Parameter]
public string DisabledProperty { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The disabled property. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
Gap
Gets or sets the spacing between items
Declaration
[Parameter]
public string Gap { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The spacing between items. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
HasValue
Gets a value indicating whether this instance has value.
Declaration
public override bool HasValue { get; }
Property Value
| Type | Description |
|---|---|
| bool |
|
Overrides
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
Items
Gets or sets the items that will be concatenated with generated items from Data.
Declaration
[Parameter]
public RenderFragment Items { get; set; }
Property Value
| Type | Description |
|---|---|
| RenderFragment | The items. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
JustifyContent
Gets or sets the content justify.
Declaration
[Parameter]
public JustifyContent JustifyContent { get; set; }
Property Value
| Type | Description |
|---|---|
| JustifyContent | The content justify. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
Orientation
Gets or sets the orientation.
Declaration
[Parameter]
public Orientation Orientation { get; set; }
Property Value
| Type | Description |
|---|---|
| Orientation | The orientation. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
ReadOnly
Gets or sets a value indicating whether is read only.
Declaration
[Parameter]
public bool ReadOnly { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
|
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
ReadOnlyProperty
Gets or sets the read-only property.
Declaration
[Parameter]
public string ReadOnlyProperty { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The read-only property. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
SelectAllText
Gets or sets the select all text.
Declaration
[Parameter]
public string SelectAllText { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The select all text. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
TextProperty
Gets or sets the text property.
Declaration
[Parameter]
public string TextProperty { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The text property. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
ValueProperty
Gets or sets the value property.
Declaration
[Parameter]
public string ValueProperty { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The value property. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
Wrap
Gets or sets the wrap.
Declaration
[Parameter]
public FlexWrap Wrap { get; set; }
Property Value
| Type | Description |
|---|---|
| FlexWrap | The wrap. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
Methods
AddItem(RadzenCheckBoxListItem<TValue>)
Adds the item.
Declaration
public void AddItem(RadzenCheckBoxListItem<TValue> item)
Parameters
| Type | Name | Description |
|---|---|---|
| RadzenCheckBoxListItem<TValue> | item | The item. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
BuildRenderTree(RenderTreeBuilder)
A checkbox group component that allows users to select multiple options from a list of choices. RadzenCheckBoxList displays multiple checkboxes with configurable layout, orientation, and data binding, binding to a collection of selected values.
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
| Type | Name | Description |
|---|---|---|
| RenderTreeBuilder | __builder |
Overrides
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
GetComponentCssClass()
Gets the component CSS class.
Declaration
protected override string GetComponentCssClass()
Returns
| Type | Description |
|---|---|
| string |
Overrides
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
IsSelected(RadzenCheckBoxListItem<TValue>)
Determines whether the specified item is selected.
Declaration
protected bool IsSelected(RadzenCheckBoxListItem<TValue> item)
Parameters
| Type | Name | Description |
|---|---|---|
| RadzenCheckBoxListItem<TValue> | item | The item. |
Returns
| Type | Description |
|---|---|
| bool |
|
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
OnParametersSet()
A checkbox group component that allows users to select multiple options from a list of choices. RadzenCheckBoxList displays multiple checkboxes with configurable layout, orientation, and data binding, binding to a collection of selected values.
Declaration
protected override void OnParametersSet()
Overrides
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
RemoveItem(RadzenCheckBoxListItem<TValue>)
Removes the item.
Declaration
public void RemoveItem(RadzenCheckBoxListItem<TValue> item)
Parameters
| Type | Name | Description |
|---|---|---|
| RadzenCheckBoxListItem<TValue> | item | The item. |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.
SelectItem(RadzenCheckBoxListItem<TValue>)
Selects the item.
Declaration
protected Task SelectItem(RadzenCheckBoxListItem<TValue> item)
Parameters
| Type | Name | Description |
|---|---|---|
| RadzenCheckBoxListItem<TValue> | item | The item. |
Returns
| Type | Description |
|---|---|
| Task |
Remarks
Checkbox lists allow multiple selections, unlike radio button lists. The bound value is a collection of all checked items. The component supports:
- Multiple Selection: Users can check/uncheck any number of items
- Data Binding: Bind to a data source via Data property or statically declare items
- Layout: Configurable orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification
- Templating: Custom item templates for complex checkbox content
- Disabled/ReadOnly Items: Individual items or the entire list can be disabled or read-only
- Keyboard Navigation: Arrow keys, Space, and Enter for accessibility
The Value property is IEnumerable<TValue> containing all selected item values. Common uses include multi-select filters, preference selections, or feature toggles.