Class ChipListBuilder

Inheritance

System.Object

ControlBuilder

ChipListBuilder

Inherited Members

ControlBuilder.Context

Namespace: Syncfusion.EJ2.Buttons

Assembly: Syncfusion.EJ2.dll

Syntax

public class ChipListBuilder : ControlBuilder

Constructors

ChipListBuilder()

Declaration

public ChipListBuilder()

ChipListBuilder(ChipList)

Declaration

public ChipListBuilder(ChipList model)

Parameters

Type	Name	Description
ChipList	model

Fields

model

Declaration

public ChipList model

Field Value

Type	Description
ChipList

Properties

HtmlAttr

Declaration

public IDictionary<string, object> HtmlAttr { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Output

Declaration

public override TextWriter Output { get; set; }

Property Value

Type	Description
System.IO.TextWriter

Overrides

ControlBuilder.Output

Methods

AvatarIconCss(String)

Specifies the icon CSS class for the avatar in the chip. {% codeBlock src='chips/avatarIconCss/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder AvatarIconCss(string avatarIconCss)

Parameters

Type	Name	Description
System.String	avatarIconCss

Returns

Type	Description
ChipListBuilder

AvatarText(String)

Specifies the customized text value for the avatar in the chip. {% codeBlock src='chips/avatarText/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder AvatarText(string avatarText)

Parameters

Type	Name	Description
System.String	avatarText

Returns

Type	Description
ChipListBuilder

BeforeClick(String)

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 ChipListBuilder BeforeClick(string beforeClick)

Parameters

Type	Name	Description
System.String	beforeClick

Returns

Type	Description
ChipListBuilder

Chips(Action<ChipCollectionBuilder>)

Declaration

public ChipListBuilder Chips(Action<ChipCollectionBuilder> chips)

Parameters

Type	Name	Description
System.Action<ChipCollectionBuilder>	chips

Returns

Type	Description
ChipListBuilder

Chips(List<ChipCollection>)

This chips property helps to render ChipList component. {% codeBlock src='chips/chips/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder Chips(List<ChipCollection> chips)

Parameters

Type	Name	Description
System.Collections.Generic.List<ChipCollection>	chips

Returns

Type	Description
ChipListBuilder

Chips(Double[])

This chips property helps to render ChipList component. {% codeBlock src='chips/chips/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder Chips(double[] chips)

Parameters

Type	Name	Description
System.Double[]	chips

Returns

Type	Description
ChipListBuilder

Chips(Object)

This chips property helps to render ChipList component. {% codeBlock src='chips/chips/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder Chips(object chips)

Parameters

Type	Name	Description
System.Object	chips

Returns

Type	Description
ChipListBuilder

Chips(String[])

This chips property helps to render ChipList component. {% codeBlock src='chips/chips/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder Chips(string[] chips)

Parameters

Type	Name	Description
System.String[]	chips

Returns

Type	Description
ChipListBuilder

Click(String)

Triggers when a chip is clicked. {% codeBlock src='chips/click/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder Click(string click)

Parameters

Type	Name	Description
System.String	click

Returns

Type	Description
ChipListBuilder

Created(String)

Triggers when the component is created successfully. {% codeBlock src='chips/created/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
ChipListBuilder

CssClass(String)

Specifies the custom classes to be added to the chip element used to customize the ChipList component. {% codeBlock src='chips/cssClass/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
ChipListBuilder

Delete(String)

Fires before removing the chip element. {% codeBlock src='chips/delete/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder Delete(string delete)

Parameters

Type	Name	Description
System.String	delete

Returns

Type	Description
ChipListBuilder

Deleted(String)

Triggers when the chip item is removed. {% codeBlock src='chips/deleted/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder Deleted(string deleted)

Parameters

Type	Name	Description
System.String	deleted

Returns

Type	Description
ChipListBuilder

Enabled(Boolean)

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

Declaration

public ChipListBuilder Enabled(bool enabled = true)

Parameters

Type	Name	Description
System.Boolean	enabled

Returns

Type	Description
ChipListBuilder

EnableDelete(Boolean)

Enables or disables the delete functionality of a chip. {% codeBlock src='chips/enableDelete/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder EnableDelete(bool enableDelete = true)

Parameters

Type	Name	Description
System.Boolean	enableDelete

Returns

Type	Description
ChipListBuilder

EnablePersistence(Boolean)

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

Declaration

public ChipListBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
ChipListBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration

public ChipListBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
ChipListBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as aria labels, title, name, etc., and accepts n number of attributes in a key-value pair format. {% codeBlock src='chiplist/htmlAttributes/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
ChipListBuilder

LeadingIconCss(String)

Specifies the leading icon CSS class for the chip. {% codeBlock src='chips/leadingIconCss/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder LeadingIconCss(string leadingIconCss)

Parameters

Type	Name	Description
System.String	leadingIconCss

Returns

Type	Description
ChipListBuilder

LeadingIconUrl(String)

Specifies the trailing icon url for the chip.

Declaration

public ChipListBuilder LeadingIconUrl(string leadingIconUrl)

Parameters

Type	Name	Description
System.String	leadingIconUrl

Returns

Type	Description
ChipListBuilder

Locale(String)

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

Declaration

public ChipListBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
ChipListBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
Microsoft.AspNetCore.Html.HtmlString

SelectedChips(Double)

Sets or gets the selected chip items in the chip list. {% codeBlock src='chips/selectedChips/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder SelectedChips(double selectedChips)

Parameters

Type	Name	Description
System.Double	selectedChips

Returns

Type	Description
ChipListBuilder

SelectedChips(Double[])

Sets or gets the selected chip items in the chip list. {% codeBlock src='chips/selectedChips/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder SelectedChips(double[] selectedChips)

Parameters

Type	Name	Description
System.Double[]	selectedChips

Returns

Type	Description
ChipListBuilder

SelectedChips(Object)

Sets or gets the selected chip items in the chip list. {% codeBlock src='chips/selectedChips/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder SelectedChips(object selectedChips)

Parameters

Type	Name	Description
System.Object	selectedChips

Returns

Type	Description
ChipListBuilder

SelectedChips(String[])

Sets or gets the selected chip items in the chip list. {% codeBlock src='chips/selectedChips/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder SelectedChips(string[] selectedChips)

Parameters

Type	Name	Description
System.String[]	selectedChips

Returns

Type	Description
ChipListBuilder

Selection(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 ChipListBuilder Selection(Selection selection)

Parameters

Type	Name	Description
Selection	selection

Returns

Type	Description
ChipListBuilder

Text(String)

Specifies the text content for the chip. {% codeBlock src='chips/text/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder Text(string text)

Parameters

Type	Name	Description
System.String	text

Returns

Type	Description
ChipListBuilder

TrailingIconCss(String)

Specifies the trailing icon CSS class for the chip. {% codeBlock src='chips/trailingIconCss/index.md' %}{% endcodeBlock %}

Declaration

public ChipListBuilder TrailingIconCss(string trailingIconCss)

Parameters

Type	Name	Description
System.String	trailingIconCss

Returns

Type	Description
ChipListBuilder

TrailingIconUrl(String)

Specifies the trailing icon url for the chip.

Declaration

public ChipListBuilder TrailingIconUrl(string trailingIconUrl)

Parameters

Type	Name	Description
System.String	trailingIconUrl

Returns

Type	Description
ChipListBuilder