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

Type Parameters

Name	Description
TValue	The type of the value.

Examples

<RadzenCheckBoxList @bind-Value=@checkedValues TValue="int" >
    <Items>
        <RadzenCheckBoxListItem Text="Orders" Value="1" />
        <RadzenCheckBoxListItem Text="Employees" Value="2" />
    </Items>
</RadzenCheckBoxList>

Constructors

RadzenCheckBoxList()

RadzenCheckBoxList component.

Declaration

public RadzenCheckBoxList()

Examples

<RadzenCheckBoxList @bind-Value=@checkedValues TValue="int" >
    <Items>
        <RadzenCheckBoxListItem Text="Orders" Value="1" />
        <RadzenCheckBoxListItem Text="Employees" Value="2" />
    </Items>
</RadzenCheckBoxList>

Properties

AlignItems

Gets or sets the items alignment.

Declaration

[Parameter]
public AlignItems AlignItems { get; set; }

Property Value

Type	Description
AlignItems	The items alignment.

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	`true` if select all values is allowed; otherwise, `false`.

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.

DisabledProperty

Gets or sets the disabled property.

Declaration

[Parameter]
public string DisabledProperty { get; set; }

Property Value

Type	Description
string	The disabled property.

Gap

Gets or sets the spacing between items

Declaration

[Parameter]
public string Gap { get; set; }

Property Value

Type	Description
string	The spacing between items.

HasValue

Gets a value indicating whether this instance has value.

Declaration

public override bool HasValue { get; }

Property Value

Type	Description
bool	`true` if this instance has value; otherwise, `false`.

Overrides

FormComponent<IEnumerable<TValue>>.HasValue

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.

JustifyContent

Gets or sets the content justify.

Declaration

[Parameter]
public JustifyContent JustifyContent { get; set; }

Property Value

Type	Description
JustifyContent	The content justify.

Orientation

Gets or sets the orientation.

Declaration

[Parameter]
public Orientation Orientation { get; set; }

Property Value

Type	Description
Orientation	The orientation.

ReadOnly

Gets or sets a value indicating whether is read only.

Declaration

[Parameter]
public bool ReadOnly { get; set; }

Property Value

Type	Description
bool	`true` if is read only; otherwise, `false`.

ReadOnlyProperty

Gets or sets the read-only property.

Declaration

[Parameter]
public string ReadOnlyProperty { get; set; }

Property Value

Type	Description
string	The read-only property.

SelectAllText

Gets or sets the select all text.

Declaration

[Parameter]
public string SelectAllText { get; set; }

Property Value

Type	Description
string	The select all text.

TextProperty

Gets or sets the text property.

Declaration

[Parameter]
public string TextProperty { get; set; }

Property Value

Type	Description
string	The text property.

ValueProperty

Gets or sets the value property.

Declaration

[Parameter]
public string ValueProperty { get; set; }

Property Value

Type	Description
string	The value property.

Wrap

Gets or sets the wrap.

Declaration

[Parameter]
public FlexWrap Wrap { get; set; }

Property Value

Type	Description
FlexWrap	The wrap.

Methods

AddItem(RadzenCheckBoxListItem<TValue>)

Adds the item.

Declaration

public void AddItem(RadzenCheckBoxListItem<TValue> item)

Parameters

Type	Name	Description
RadzenCheckBoxListItem<TValue>	item	The item.

BuildRenderTree(RenderTreeBuilder)

RadzenCheckBoxList component.

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected override string GetComponentCssClass()

Returns

Type	Description
string

Overrides

RadzenComponent.GetComponentCssClass()

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

OnParametersSet()

RadzenCheckBoxList component.

Declaration

protected override void OnParametersSet()

Overrides

ComponentBase.OnParametersSet()

RemoveItem(RadzenCheckBoxListItem<TValue>)

Removes the item.

Declaration

public void RemoveItem(RadzenCheckBoxListItem<TValue> item)

Parameters

Type	Name	Description
RadzenCheckBoxListItem<TValue>	item	The item.

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

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

IRadzenFormComponent