Class RadzenCheckBoxList<TValue>

RadzenCheckBoxList component.

Inheritance

System.Object

RadzenComponent

FormComponent<IEnumerable<TValue>>

RadzenCheckBoxList<TValue>

Implements

IDisposable

IRadzenFormComponent

Inherited Members

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>>.Value

FormComponent<IEnumerable<TValue>>.Change

FormComponent<IEnumerable<TValue>>.FieldIdentifier

FormComponent<IEnumerable<TValue>>.ValueExpression

FormComponent<IEnumerable<TValue>>.SetParametersAsync(ParameterView)

FormComponent<IEnumerable<TValue>>.Dispose()

FormComponent<IEnumerable<TValue>>.GetValue()

FormComponent<IEnumerable<TValue>>.OnContextMenu(MouseEventArgs)

FormComponent<IEnumerable<TValue>>.GetClassList(String)

FormComponent<IEnumerable<TValue>>.FormFieldContext

FormComponent<IEnumerable<TValue>>.CurrentPlaceholder

FormComponent<IEnumerable<TValue>>.FocusAsync()

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.OnContextMenu(Microsoft.AspNetCore.Components.Web.MouseEventArgs)

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.Debounce(Func<Task>, Int32)

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.OnInitialized()

RadzenComponent.Reference

RadzenComponent.OnAfterRenderAsync(Boolean)

RadzenComponent.RaiseContextMenu(Microsoft.AspNetCore.Components.Web.MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.CurrentStyle

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenCheckBoxList<TValue> : FormComponent<IEnumerable<TValue>>, 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>

Properties

AllowSelectAll

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

Data

Gets or sets the data used to generate items.

Declaration

public virtual IEnumerable Data { get; set; }

Property Value

Type	Description
IEnumerable	The data.

DisabledProperty

Gets or sets the disabled property.

Declaration

public string DisabledProperty { get; set; }

Property Value

Type	Description
System.String	The disabled property.

HasValue

Gets a value indicating whether this instance has value.

Declaration

public override bool HasValue { get; }

Property Value

Type	Description
System.Boolean	true if this instance has value; otherwise, false.

Overrides

Radzen.FormComponent<IEnumerable<TValue>>.HasValue

Items

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

Declaration

public RenderFragment Items { get; set; }

Property Value

Type	Description
RenderFragment	The items.

Orientation

Gets or sets the orientation.

Declaration

public Orientation Orientation { get; set; }

Property Value

Type	Description
Orientation	The orientation.

ReadOnly

Gets or sets a value indicating whether is read only.

Declaration

public bool ReadOnly { get; set; }

Property Value

Type	Description
System.Boolean	true if is read only; otherwise, false.

ReadOnlyProperty

Gets or sets the read-only property.

Declaration

public string ReadOnlyProperty { get; set; }

Property Value

Type	Description
System.String	The read-only property.

SelectAllText

Gets or sets the select all text.

Declaration

public string SelectAllText { get; set; }

Property Value

Type	Description
System.String	The select all text.

TextProperty

Gets or sets the text property.

Declaration

public string TextProperty { get; set; }

Property Value

Type	Description
System.String	The text property.

ValueProperty

Gets or sets the value property.

Declaration

public string ValueProperty { get; set; }

Property Value

Type	Description
System.String	The value property.

Methods

AddItem(RadzenCheckBoxListItem<TValue>)

Adds the item.

Declaration

public void AddItem(RadzenCheckBoxListItem<TValue> item)

Parameters

Type	Name	Description
RadzenCheckBoxListItem<TValue>	item	The item.

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected override string GetComponentCssClass()

Returns

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

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 async System.Threading.Tasks.Task SelectItem(RadzenCheckBoxListItem<TValue> item)

Parameters

Type	Name	Description
RadzenCheckBoxListItem<TValue>	item	The item.

Returns

Type	Description
System.Threading.Tasks.Task

Implements

IDisposable

IRadzenFormComponent