menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ListBoxModel<T> - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ListBoxModel<T>

    Interface for a class ListBox.

    Inheritance
    System.Object
    ListBoxModel<T>
    Namespace: Syncfusion.Blazor.DropDowns
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class ListBoxModel<T> : Object
    Type Parameters
    Name
    T

    Constructors

    ListBoxModel()

    Declaration
    public ListBoxModel()

    Properties

    ActionBegin

    Triggers before fetching data from the remote server.

    Declaration
    public ActionBeginEventArgs ActionBegin { get; set; }
    Property Value
    Type
    ActionBeginEventArgs

    ActionComplete

    Triggers after data is fetched successfully from the remote server.

    Declaration
    public ActionCompleteEventArgs ActionComplete { get; set; }
    Property Value
    Type
    ActionCompleteEventArgs

    ActionFailure

    Triggers when the data fetch request from the remote server fails.

    Declaration
    public EventCallback<object> ActionFailure { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    AllowDragAndDrop

    If 'allowDragAndDrop' is set to true, then you can perform drag and drop of the list item. ListBox contains same 'scope' property enables drag and drop between multiple ListBox.

    Declaration
    public bool AllowDragAndDrop { get; set; }
    Property Value
    Type
    System.Boolean

    AllowFiltering

    To enable the filtering option in this component. Filter action performs when type in search box and collect the matched item through filtering event. If searching character does not match, noRecordsTemplate property value will be shown.

    Declaration
    public bool AllowFiltering { get; set; }
    Property Value
    Type
    System.Boolean

    BeforeDrop

    Triggers before dropping the list item on another list item.

    Declaration
    public EventCallback<object> BeforeDrop { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    BeforeItemRender

    Triggers while rendering each list item.

    Declaration
    public EventCallback<object> BeforeItemRender { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    Change

    Triggers while select / unselect the list item.

    Declaration
    public EventCallback<object> Change { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    Created

    Triggers when the component is created.

    Declaration
    public EventCallback<object> Created { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    CssClass

    Sets the CSS classes to root element of this component, which helps to customize the complete styles.

    Declaration
    public string CssClass { get; set; }
    Property Value
    Type
    System.String

    Destroyed

    Triggers when the component is destroyed.

    Declaration
    public EventCallback<object> Destroyed { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    Drag

    Triggers while dragging the list item.

    Declaration
    public EventCallback<object> Drag { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    DragStart

    Triggers after dragging the list item.

    Declaration
    public EventCallback<object> DragStart { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    Drop

    Triggers before dropping the list item on another list item.

    Declaration
    public EventCallback<object> Drop { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    EnableRtl

    Enable or disable rendering component in right to left direction.

    Declaration
    public bool EnableRtl { get; set; }
    Property Value
    Type
    System.Boolean

    Filtering

    Triggers on typing a character in the component.

    Declaration
    public EventCallback<object> Filtering { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    Height

    Sets the height of the ListBox component.

    Declaration
    public object Height { get; set; }
    Property Value
    Type
    System.Object

    MaximumSelectionLength

    Sets limitation to the value selection. Based on the limitation, list selection will be prevented.

    Declaration
    public double MaximumSelectionLength { get; set; }
    Property Value
    Type
    System.Double

    Scope

    Defines the scope value to group sets of draggable and droppable ListBox. A draggable with the same scope value will be accepted by the droppable.

    Declaration
    public string Scope { get; set; }
    Property Value
    Type
    System.String

    SelectionSettings

    Specifies the selection mode and its type.

    Declaration
    public SelectionSettingsModel SelectionSettings { get; set; }
    Property Value
    Type
    SelectionSettingsModel

    ToolbarSettings

    Specifies the toolbar items and its position.

    Declaration
    public ToolbarSettingsModel ToolbarSettings { get; set; }
    Property Value
    Type
    ToolbarSettingsModel

    Value

    Sets the specified item to the selected state or gets the selected item in the ListBox.

    Declaration
    public T Value { get; set; }
    Property Value
    Type
    T
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved