ClassTelerikListBox<TItem>
The class for the Telerik ListBox component.
Definition
Namespace:Telerik.Blazor.Components
Assembly:Telerik.Blazor.dll
Type Parameters:
TItem
Syntax:
public class TelerikListBox<TItem> : DataBoundComponent<TItem>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Inheritance: objectComponentBaseBaseComponentDataBoundComponent<TItem>TelerikListBox<TItem>
Implements:
Inherited Members
Constructors
TelerikListBox()
Declaration
public TelerikListBox()
Properties
AriaLabel
Describe the aria-label attribute for the items list.
Declaration
[Parameter]
public string AriaLabel { get; set; }
Property Value
AriaLabelledBy
Describe the aria-labelledby attribute for the items list.
Declaration
[Parameter]
public string AriaLabelledBy { get; set; }
Property Value
ConnectedListBoxId
The id of the list box you want to connect this list box with. Its value should be the same as the Id value of the connected list box.
Declaration
[Parameter]
public string ConnectedListBoxId { get; set; }
Property Value
Draggable
Specifies whether the list box items can be dragged and dropped. This applies to both items within the same list box, as well as across multiple list boxes. Default value is false.
DropSources
Specifies the ids of the list box components that can drag and drop items to the current list box. The DropSources option describes a one-way relationship. If you want a two-way connection, set the DropSources option to both components.
Height
Defines the component height as a CSS value.
Id
The id of the list box. If you want to connect multiple list boxes, assign the same value to the ConnectedListBoxId of the corresponding list box.
ItemTemplate
The item template of the list box items. Use to override the default rendering of individual items.
Declaration
[Parameter]
public RenderFragment<TItem> ItemTemplate { get; set; }
Property Value
RenderFragment<TItem>
ListBoxToolBarSettings
The container for the list box tool bar. Add a ListBoxToolBar tag within this fragment.
Declaration
[Parameter]
public RenderFragment ListBoxToolBarSettings { get; set; }
Property Value
NoDataTemplate
Defines the content of the list box when there is no data.
Declaration
[Parameter]
public RenderFragment NoDataTemplate { get; set; }
Property Value
OnDrop
Fires when the user drops dragged items. All data manipulations should be made here. Requires Draggable set to true.
Declaration
[Parameter]
public EventCallback<ListBoxDropEventArgs<TItem>> OnDrop { get; set; }
Property Value
EventCallback<ListBoxDropEventArgs<TItem>>
OnRemove
Fires when the user initiate deletion of items. The event fires only for the list box owning the tool bar.
Declaration
[Parameter]
public EventCallback<ListBoxRemoveEventArgs<TItem>> OnRemove { get; set; }
Property Value
EventCallback<ListBoxRemoveEventArgs<TItem>>
OnReorder
Fires when the user initiate reorder of items. The event fires only for the list box owning the tool bar.
Declaration
[Parameter]
public EventCallback<ListBoxReorderEventArgs<TItem>> OnReorder { get; set; }
Property Value
EventCallback<ListBoxReorderEventArgs<TItem>>
OnTransfer
Fires when the user initiates a transfer of items from one list box to another list box. The event fires only for the list box owning the tool bar.
Declaration
[Parameter]
public EventCallback<ListBoxTransferEventArgs<TItem>> OnTransfer { get; set; }
Property Value
SelectedItems
Specifies the selected items. Used with two-way binding.
Declaration
[Parameter]
public IEnumerable<TItem> SelectedItems { get; set; }
Property Value
IEnumerable<TItem>
SelectedItemsChanged
Specifies the callback that's called when the selected items change.
Declaration
[Parameter]
public EventCallback<IEnumerable<TItem>> SelectedItemsChanged { get; set; }
Property Value
EventCallback<IEnumerable<TItem>>
SelectionMode
Declaration
[Parameter]
public ListBoxSelectionMode SelectionMode { get; set; }
Property Value
TextField
Defines the TextField of the Data. Default value: "Text".
Declaration
[Parameter]
public string TextField { get; set; }
Property Value
ToolBarPosition
Declaration
[Parameter]
public ListBoxToolBarPosition ToolBarPosition { get; set; }
Property Value
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builder
Overrides
Dispose()
Declaration
public override void Dispose()
Overrides
OnInitialized()
Declaration
protected override void OnInitialized()
Overrides
SetParametersAsync(ParameterView)
Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
parameters
Returns
Overrides