Class ChipList

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

ChipList

Namespace: Syncfusion.EJ2.Buttons

Assembly: Syncfusion.EJ2.dll

Syntax

public class ChipList : EJTagHelper

Constructors

ChipList()

Declaration

public ChipList()

Properties

AllowDragAndDrop

Specifies a boolean value that indicates whether the chip item can be dragged and reordered. This enables drag-and-drop functionality within a single container or across multiple containers of chips when dragging is enabled.

Declaration

public bool AllowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

AvatarIconCss

Specifies the icon CSS class for the avatar in the chip.

Declaration

public string AvatarIconCss { get; set; }

Property Value

Type	Description
System.String	The default value is ""

AvatarText

Specifies the customized text value for the avatar in the chip.

Declaration

public string AvatarText { get; set; }

Property Value

Type	Description
System.String	The default value is ""

BeforeClick

Triggers before the click event of the chip is fired. This event can be used to prevent the further process and restrict the click action over a chip.

Declaration

public string BeforeClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

Chips

This chips property helps to render ChipList component.

Declaration

public object Chips { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Click

Triggers when a chip is clicked.

Declaration

public string Click { get; set; }

Property Value

Type	Description
System.String	The default value is null

Created

Triggers when the component is created successfully.

Declaration

public string Created { get; set; }

Property Value

Type	Description
System.String	The default value is null

CssClass

Specifies the custom classes to be added to the chip element used to customize the ChipList component.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Delete

Fires before removing the chip element.

Declaration

public string Delete { get; set; }

Property Value

Type	Description
System.String	The default value is null

Deleted

Triggers when the chip item is removed.

Declaration

public string Deleted { get; set; }

Property Value

Type	Description
System.String	The default value is null

DragArea

Specifies the target in which the draggable element can be moved and dropped. By default, the draggable element movement occurs in the page.

Declaration

public string DragArea { get; set; }

Property Value

Type	Description
System.String	The default value is null

Dragging

Fires while a chip item is being dragged.

Declaration

public string Dragging { get; set; }

Property Value

Type	Description
System.String	The default value is null

DragStart

Fires when a chip item starts moving due to a drag action.

Declaration

public string DragStart { get; set; }

Property Value

Type	Description
System.String	The default value is null

DragStop

Fires when a chip item is reordered after completing a drag action.

Declaration

public string DragStop { get; set; }

Property Value

Type	Description
System.String	The default value is null

Enabled

Specifies a value that indicates whether the chip component is enabled or not.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableDelete

Enables or disables the delete functionality of a chip.

Declaration

public bool EnableDelete { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

HtmlAttributes

Allows additional HTML attributes such as aria labels, title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public object HtmlAttributes { get; set; }

Property Value

Type	Description
System.Object	The default value is null

LeadingIconCss

Specifies the leading icon CSS class for the chip.

Declaration

public string LeadingIconCss { get; set; }

Property Value

Type	Description
System.String	The default value is ""

LeadingIconUrl

Specifies the leading icon url for the chip.

Declaration

public string LeadingIconUrl { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String	The default value is ""

SelectedChips

Sets or gets the selected chip items in the chip list.

Declaration

public object SelectedChips { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Selection

Defines the selection type of the chip. The available types are:

1. Input chip
2. Choice chip
3. Filter chip
4. Action chip

Declaration

public Selection Selection { get; set; }

Property Value

Type	Description
Selection	The default value is Selection.None

Text

Specifies the text content for the chip.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	The default value is ""

TrailingIconCss

Specifies the trailing icon CSS class for the chip.

Declaration

public string TrailingIconCss { get; set; }

Property Value

Type	Description
System.String	The default value is ""

TrailingIconUrl

Specifies the trailing icon url for the chip.

Declaration

public string TrailingIconUrl { get; set; }

Property Value

Type	Description
System.String	The default value is ""