RadzenCheckBoxList<TValue> Class

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. Allows multiple selections, unlike radio button lists. The bound value is a collection of all checked items. Supports multiple selection where users can check/uncheck any number of items, data binding via Data property or static item declaration, configurable layout including orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification, custom item templates for complex checkbox content, disabled/read-only items individually or for the entire list, and keyboard navigation (Arrow keys, Space, 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.

Inheritance

Object

ComponentBase

RadzenComponent

FormComponent<IEnumerable<TValue>>

RadzenCheckBoxList<TValue>

Implements

IComponent

IHandleEvent

IHandleAfterRender

IRadzenFormComponent

Inherited Members

FormComponent<IEnumerable<TValue>>.SetParametersAsync

FormComponent<IEnumerable<TValue>>.Dispose

FormComponent<IEnumerable<TValue>>.GetValue

FormComponent<IEnumerable<TValue>>.NotifyFieldChanged

FormComponent<IEnumerable<TValue>>.OnContextMenu

FormComponent<IEnumerable<TValue>>.GetClassList

FormComponent<IEnumerable<TValue>>.FocusAsync

FormComponent<IEnumerable<TValue>>.Name

FormComponent<IEnumerable<TValue>>.TabIndex

FormComponent<IEnumerable<TValue>>.Placeholder

FormComponent<IEnumerable<TValue>>.Disabled

FormComponent<IEnumerable<TValue>>.EditContext

FormComponent<IEnumerable<TValue>>.Form

FormComponent<IEnumerable<TValue>>.ValueChanged

FormComponent<IEnumerable<TValue>>.IsBound

FormComponent<IEnumerable<TValue>>.Value

FormComponent<IEnumerable<TValue>>.Change

FormComponent<IEnumerable<TValue>>.FieldIdentifier

FormComponent<IEnumerable<TValue>>.ValueExpression

FormComponent<IEnumerable<TValue>>.FormFieldContext

FormComponent<IEnumerable<TValue>>.CurrentPlaceholder

FormComponent<IEnumerable<TValue>>._value

RadzenComponent.OnMouseEnter

RadzenComponent.OnMouseLeave

RadzenComponent.GetCssClass

RadzenComponent.GetId

RadzenComponent.Debounce

RadzenComponent.Localize

RadzenComponent.OnInitialized

RadzenComponent.OnAfterRenderAsync

RadzenComponent.RaiseContextMenu

RadzenComponent.RaiseMouseEnter

RadzenComponent.AddContextMenu

RadzenComponent.RaiseMouseLeave

RadzenComponent.OnBecameInvisible

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.UICulture

RadzenComponent.DefaultUICulture

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.Reference

RadzenComponent.CurrentStyle

ComponentBase.OnInitializedAsync

ComponentBase.OnParametersSetAsync

ComponentBase.StateHasChanged

ComponentBase.ShouldRender

ComponentBase.OnAfterRender

ComponentBase.InvokeAsync

ComponentBase.DispatchExceptionAsync

ComponentBase.RendererInfo

ComponentBase.Assets

ComponentBase.AssignedRenderMode

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenCheckBoxList<TValue> : FormComponent<IEnumerable<TValue>>, IComponent, IHandleEvent, IHandleAfterRender, IRadzenFormComponent

Type Parameters

Name Description
TValueThe type of individual item values. The bound Value is IEnumerable<TValue> containing all selected items.

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<TValue>Link to this section

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. Allows multiple selections, unlike radio button lists. The bound value is a collection of all checked items. Supports multiple selection where users can check/uncheck any number of items, data binding via Data property or static item declaration, configurable layout including orientation (Horizontal/Vertical), gap spacing, wrapping, alignment, and justification, custom item templates for complex checkbox content, disabled/read-only items individually or for the entire list, and keyboard navigation (Arrow keys, Space, 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.

Declaration
public RadzenCheckBoxList<TValue>()

Properties

AlignItemsLink to this section

Gets or sets the items alignment.

Declaration
public AlignItems AlignItems { get; set; }
Property Value
Type Description
AlignItemsGets or sets the items alignment.

AllowSelectAllLink to this section

Gets or sets a value indicating whether the user can select all values. Set to false by default.

Declaration
public bool AllowSelectAll { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether the user can select all values. Set to false by default.

DataLink to this section

Gets or sets the data used to generate items.

Declaration
public Collections.IEnumerable Data { get; set; }
Property Value
Type Description
Collections.IEnumerableGets or sets the data used to generate items.

DisabledPropertyLink to this section

Gets or sets the disabled property.

Declaration
public string DisabledProperty { get; set; }
Property Value
Type Description
stringGets or sets the disabled property.

GapLink to this section

Gets or sets the spacing between items

Declaration
public string Gap { get; set; }
Property Value
Type Description
stringGets or sets the spacing between items

HasValueLink to this section

Gets a value indicating whether this instance has value.

Declaration
public bool HasValue { get; }
Property Value
Type Description
boolGets a value indicating whether this instance has value.

ItemsLink to this section

Gets or sets the items that will be concatenated with generated items from Data.

Declaration
public RenderFragment Items { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the items that will be concatenated with generated items from Data.

JustifyContentLink to this section

Gets or sets the content justify.

Declaration
public JustifyContent JustifyContent { get; set; }
Property Value
Type Description
JustifyContentGets or sets the content justify.

OrientationLink to this section

Gets or sets the orientation.

Declaration
public Orientation Orientation { get; set; }
Property Value
Type Description
OrientationGets or sets the orientation.

ReadOnlyLink to this section

Gets or sets a value indicating whether is read only.

Declaration
public bool ReadOnly { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether is read only.

ReadOnlyPropertyLink to this section

Gets or sets the read-only property.

Declaration
public string ReadOnlyProperty { get; set; }
Property Value
Type Description
stringGets or sets the read-only property.

SelectAllTextLink to this section

Gets or sets the select all text.

Declaration
public string SelectAllText { get; set; }
Property Value
Type Description
stringGets or sets the select all text.

TextPropertyLink to this section

Gets or sets the text property.

Declaration
public string TextProperty { get; set; }
Property Value
Type Description
stringGets or sets the text property.

ValuePropertyLink to this section

Gets or sets the value property.

Declaration
public string ValueProperty { get; set; }
Property Value
Type Description
stringGets or sets the value property.

WrapLink to this section

Gets or sets the wrap.

Declaration
public FlexWrap Wrap { get; set; }
Property Value
Type Description
FlexWrapGets or sets the wrap.

Methods

AddItemLink to this section

Adds the item.

Declaration
public void AddItem(RadzenCheckBoxListItem<TValue> item)
Parameters
Type Name Description
RadzenCheckBoxListItem<TValue> item The item.

BuildRenderTreeLink to this section

Declaration
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)
Parameters
Type Name Description
Rendering.RenderTreeBuilder __builder

GetComponentCssClassLink to this section

Declaration
protected override string GetComponentCssClass()
Returns
Type Description
string

IsSelectedLink to this section

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
booltrue if the specified item is selected; otherwise, false.

OnParametersSetLink to this section

Declaration
protected override void OnParametersSet()

RemoveItemLink to this section

Removes the item.

Declaration
public void RemoveItem(RadzenCheckBoxListItem<TValue> item)
Parameters
Type Name Description
RadzenCheckBoxListItem<TValue> item The item.

SelectItemLink to this section

Selects the item.

Declaration
protected Task SelectItem(RadzenCheckBoxListItem<TValue> item)
Parameters
Type Name Description
RadzenCheckBoxListItem<TValue> item The item.
Returns
Type Description
Task
An error has occurred. This app may no longer respond until reloaded. Reload 🗙