Class ChipListBuilder
Inheritance
System.Object
ChipListBuilder
Assembly: Syncfusion.EJ2.dll
public class ChipListBuilder : ControlBuilder
Constructors
Declaration
Declaration
public ChipListBuilder(ChipList model)
Parameters
Fields
Declaration
Field Value
Properties
Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.IDictionary<System.String, System.Object> |
|
Declaration
public string ID { get; set; }
Property Value
Type |
Description |
System.String |
|
Declaration
public override TextWriter Output { get; set; }
Property Value
Type |
Description |
System.IO.TextWriter |
|
Overrides
Methods
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
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
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
Declaration
public ChipListBuilder Chips(Action<ChipCollectionBuilder> chips)
Parameters
Returns
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Specifies the trailing icon url for the chip.
Declaration
public ChipListBuilder LeadingIconUrl(string leadingIconUrl)
Parameters
Type |
Name |
Description |
System.String |
leadingIconUrl |
|
Returns
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
Declaration
public HtmlString Render()
Returns
Type |
Description |
Microsoft.AspNetCore.Html.HtmlString |
|
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
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
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
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
Defines the selection type of the chip. The available types are:
- Input chip
- Choice chip
- Filter chip
- Action chip
Declaration
public ChipListBuilder Selection(Selection selection)
Parameters
Returns
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
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
Specifies the trailing icon url for the chip.
Declaration
public ChipListBuilder TrailingIconUrl(string trailingIconUrl)
Parameters
Type |
Name |
Description |
System.String |
trailingIconUrl |
|
Returns