Class RadzenCheckBoxList<TValue>

Namespace

Radzen.Blazor

Assembly

Radzen.Blazor.dll

RadzenCheckBoxList component.

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

Type Parameters

TValue

The type of the value.

Inheritance

object

ComponentBase

RadzenComponent

FormComponent<IEnumerable<TValue>>

RadzenCheckBoxList<TValue>

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

IRadzenFormComponent

Inherited Members

FormComponent<IEnumerable<TValue>>._value

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

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.Debounce(Func<Task>, int)

RadzenComponent.OnInitialized()

RadzenComponent.OnAfterRenderAsync(bool)

RadzenComponent.RaiseContextMenu(MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.Reference

RadzenComponent.CurrentStyle

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSet()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

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

Constructors

RadzenCheckBoxList()

public RadzenCheckBoxList()

Properties

AllowSelectAll

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

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

Property Value

bool

true if select all values is allowed; otherwise, false.

Data

Gets or sets the data used to generate items.

[Parameter]
public virtual IEnumerable Data { get; set; }

Property Value

IEnumerable

The data.

DisabledProperty

Gets or sets the disabled property.

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

Property Value

string

The disabled property.

HasValue

Gets a value indicating whether this instance has value.

public override bool HasValue { get; }

Property Value

bool

true if this instance has value; otherwise, false.

Items

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

[Parameter]
public RenderFragment Items { get; set; }

Property Value

RenderFragment

The items.

Orientation

Gets or sets the orientation.

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

Property Value

Orientation

The orientation.

ReadOnly

Gets or sets a value indicating whether is read only.

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

Property Value

bool

true if is read only; otherwise, false.

ReadOnlyProperty

Gets or sets the read-only property.

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

Property Value

string

The read-only property.

SelectAllText

Gets or sets the select all text.

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

Property Value

string

The select all text.

TextProperty

Gets or sets the text property.

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

Property Value

string

The text property.

ValueProperty

Gets or sets the value property.

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

Property Value

string

The value property.

Methods

AddItem(RadzenCheckBoxListItem<TValue>)

Adds the item.

public void AddItem(RadzenCheckBoxListItem<TValue> item)

Parameters

item RadzenCheckBoxListItem<TValue>

The item.

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

GetComponentCssClass()

protected override string GetComponentCssClass()

Returns

string

IsSelected(RadzenCheckBoxListItem<TValue>)

Determines whether the specified item is selected.

protected bool IsSelected(RadzenCheckBoxListItem<TValue> item)

Parameters

item RadzenCheckBoxListItem<TValue>

The item.

Returns

bool

true if the specified item is selected; otherwise, false.

RemoveItem(RadzenCheckBoxListItem<TValue>)

Removes the item.

public void RemoveItem(RadzenCheckBoxListItem<TValue> item)

Parameters

item RadzenCheckBoxListItem<TValue>

The item.

SelectItem(RadzenCheckBoxListItem<TValue>)

Selects the item.

protected Task SelectItem(RadzenCheckBoxListItem<TValue> item)

Parameters

item RadzenCheckBoxListItem<TValue>

The item.

Returns

Task