Class

TelerikListBox<TItem>

Declaration

public TelerikListBox()

Describe the aria-label attribute for the items list.

Declaration

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

Property Value

Describe the aria-labelledby attribute for the items list.

Declaration

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

Property Value

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

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.

Declaration

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

Property Value

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.

Declaration

[Parameter]
public List<string> DropSources { get; set; }

Property Value

Whether the list box is enabled. Default value is true.

Declaration

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

Property Value

Defines the component height as a CSS value.

Declaration

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

Property Value

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.

Declaration

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

Property Value

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

The container for the list box tool bar. Add a ListBoxToolBar tag within this fragment.

Declaration

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

Property Value

Defines the content of the list box when there is no data.

Declaration

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

Property Value

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

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

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

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

Specifies the selected items. Used with two-way binding.

Declaration

[Parameter]
public IEnumerable<TItem> SelectedItems { get; set; }

Property Value

Specifies the callback that's called when the selected items change.

Declaration

[Parameter]
public EventCallback<IEnumerable<TItem>> SelectedItemsChanged { get; set; }

Property Value

Defines scrolling mode of the list box. Possible values are Single(default) and Multiple.

Declaration

[Parameter]
public ListBoxSelectionMode SelectionMode { get; set; }

Property Value

Specifies the size of the list box. Possible values are Small(default), Medium(default), and Large.

Declaration

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

Property Value

Defines the TextField of the Data. Default value: "Text".

Declaration

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

Property Value

Defines the position of the ToolBar. Possible values are Right(default), Left, Top, and Bottom.

Declaration

[Parameter]
public ListBoxToolBarPosition ToolBarPosition { get; set; }

Property Value

Defines the component width as a CSS value.

Declaration

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

Property Value

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Declaration

public override void Dispose()

Overrides DataBoundComponent<TItem>.Dispose()

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Returns

Overrides BaseComponent.OnAfterRenderAsync(bool)

Declaration

protected override void OnInitialized()

Overrides ComponentBase.OnInitialized()

Declaration

protected override Task OnParametersSetAsync()

Returns

Overrides DataBoundComponent<TItem>.OnParametersSetAsync()

Re-renders the component.

Declaration

public void Refresh()

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Returns

Overrides DataBoundComponent<TItem>.SetParametersAsync(ParameterView)