Class SfChipGroup
Represents a grouping control which adds SfChips control to a layout and grouped them for selection.
Inheritance
Implements
Namespace: Syncfusion.XForms.Buttons
Assembly: Syncfusion.Buttons.XForms.dll
Syntax
public class SfChipGroup : ContentView, IDisposable, IParentThemeElement, IThemeElement
Constructors
SfChipGroup()
Initializes a new instance of the SfChipGroup class. This is constructor of the SfChipGroup class.
Declaration
public SfChipGroup()
Fields
ChipBackgroundColorProperty
Identifies the ChipBackgroundColor property. This property can be used to change the background color of the chip in the chip group. This is a bindable property.
Declaration
public static readonly BindableProperty ChipBackgroundColorProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ChipBorderColorProperty
Identifies the ChipBorderColor property. This property can be used to change the border color of the chip in the chip group. This is a bindable property.
Declaration
public static readonly BindableProperty ChipBorderColorProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ChipBorderWidthProperty
Identifies the ChipBorderWidth property. This property can be used to change the border width of chips. This is bindable property.
Declaration
public static readonly BindableProperty ChipBorderWidthProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ChipFontAttributesProperty
Identifies the FontAttributes property.
Declaration
public static readonly BindableProperty ChipFontAttributesProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ChipFontFamilyProperty
Identifies the FontFamily property.
Declaration
public static readonly BindableProperty ChipFontFamilyProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ChipImageWidthProperty
Identifies the ChipImageWidth property. This property can be used to customize the width of the chip image. This is a bindable property.
Declaration
public static readonly BindableProperty ChipImageWidthProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ChipLayoutProperty
Identifies the ChipLayout property. This property can be used to add all the chips in a chip group. This is a bindable property.
Declaration
public static readonly BindableProperty ChipLayoutProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ChipPaddingProperty
Identifies the ChipPadding property. This property can be used to set spacing between the chips. This is a bindable property.
Declaration
public static readonly BindableProperty ChipPaddingProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ChipTextColorProperty
Identifies the ChipTextColor property. This property can be used to change the text color of the chip in the chip group. This is a bindable property.
Declaration
public static readonly BindableProperty ChipTextColorProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ChipTextSizeProperty
Identifies the ChipTextSize property. This property can be used to change the text size for the chip in the chip group. This is a bindable property.
Declaration
public static readonly BindableProperty ChipTextSizeProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ChoiceModeProperty
Gets or sets a value that indicates the selection mode of chip item in the Choice type. This is a bindable property.
Declaration
public static readonly BindableProperty ChoiceModeProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
Remarks
This property is applicable for Choice only.
CloseButtonColorProperty
Identifies the CloseButtonColor property. Using this proprty, you can change the color of the close button in chip. This is bindable property.
Declaration
public static readonly BindableProperty CloseButtonColorProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
CommandProperty
Identifies the Command property. This property can be used to set command to the chip group. This is a bindable property.
Declaration
public static readonly BindableProperty CommandProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
DisplayMemberPathProperty
Identifies the DisplayMemberPath property. It is a member path for the display text in chip. This is a bindable property.
Declaration
public static readonly BindableProperty DisplayMemberPathProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ImageMemberPathProperty
Identifies the ImageMemberPath property. It is a member path for the icon image in chip. This is a bindable property.
Declaration
public static readonly BindableProperty ImageMemberPathProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
InputViewProperty
Identifies the InputView property. This property can be used to set the input view or editor in the Input chip group. This is a bindable property.
Declaration
public static readonly BindableProperty InputViewProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ItemHeightProperty
Identifies the ItemHeight property. This property can be used to customize the height of the chips in group. This is bindable property.
Declaration
public static readonly BindableProperty ItemHeightProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ItemsProperty
Identifies the Items property. This property can be used to set items to the chip group. This is a bindable property.
Declaration
public static readonly BindableProperty ItemsProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ItemsSourceProperty
Identifies the ItemsSource property. This property can be used to set items source for chip group. This is a bindable property.
Declaration
public static readonly BindableProperty ItemsSourceProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ItemTemplateProperty
Identifies the ItemTemplate property. This property can be used to set custom content to data item in the chip group control. This is a bindable property.
Declaration
public static readonly BindableProperty ItemTemplateProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
SelectedChipBackgroundColorProperty
Identifies the SelectedChipBackgroundColor property. This property can be used to change the background color for the selected chip in the chip group. This is a bindable property.
Declaration
public static readonly BindableProperty SelectedChipBackgroundColorProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
SelectedChipTextColorProperty
Identifies the SelectedChipTextColor property. This property can be used to change the the text color for the selected chip in the chip group. This is a bindable property.
Declaration
public static readonly BindableProperty SelectedChipTextColorProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
SelectedItemProperty
Identifies the SelectedItem property. This property can be used to select a particular item in the Choice chip group. This is a bindable property.
Declaration
public static readonly BindableProperty SelectedItemProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
SelectedItemsProperty
Identifies the SelectedItems property. This property can be used to select a particular item in the Filter chip group. This is a bindable property.
Declaration
public static readonly BindableProperty SelectedItemsProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
SelectionIndicatorColorProperty
Identifies the SelectionIndicatorColor property. Using this proprty, you can change the color of the selection indicator in chip. This is a bindable property.
Declaration
public static readonly BindableProperty SelectionIndicatorColorProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
ShowIconProperty
Identifies the ShowIcon property. This property indicates whether icon is visible in chip. This is bindable property.
Declaration
public static readonly BindableProperty ShowIconProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
TypeProperty
Identifies the Type property. This property can be used to set the type of the chips in the chip group. This is a bindable property.
Declaration
public static readonly BindableProperty TypeProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
Properties
ChipBackgroundColor
Gets or sets the value of ChipBackgroundColor. This property can be used to change the background color of the chip in the chip group.
Declaration
public Color ChipBackgroundColor { get; set; }
Property Value
Type |
---|
Xamarin.Forms.Color |
ChipBorderColor
Gets or sets the value of the ChipBorderColor. This property can be used to change the border color of the chip in the chip group.
Declaration
public Color ChipBorderColor { get; set; }
Property Value
Type |
---|
Xamarin.Forms.Color |
ChipBorderWidth
Gets or sets the value of the ChipBorderWidth. This property can be used to change the border width of chips. This is a bindable property.
Declaration
public double ChipBorderWidth { get; set; }
Property Value
Type |
---|
System.Double |
ChipFontAttributes
Gets or sets the font attributes for the SfChip.
Declaration
public FontAttributes ChipFontAttributes { get; set; }
Property Value
Type |
---|
Xamarin.Forms.FontAttributes |
ChipFontFamily
Gets or sets the font family for the SfChip.
Declaration
public string ChipFontFamily { get; set; }
Property Value
Type |
---|
System.String |
ChipImageWidth
Gets or sets the value of the ChipImgaeWidth. This property can be used to customize the width of the chip image. This is a bindable property.
Declaration
public int ChipImageWidth { get; set; }
Property Value
Type |
---|
System.Int32 |
ChipLayout
Gets or sets the value of ChipLayout. This property can be used to add all the chips in a chip group.
Declaration
public Layout<View> ChipLayout { get; set; }
Property Value
Type |
---|
Xamarin.Forms.Layout<Xamarin.Forms.View> |
ChipPadding
Gets or sets the value of ChipPadding. This chip padding is used for arranging the items with viewable padding in horizontal orientation.
Declaration
public Thickness ChipPadding { get; set; }
Property Value
Type | Description |
---|---|
Xamarin.Forms.Thickness | The chip padding. |
ChipTextColor
Gets or sets the value of ChipTextColor. This property can be used to change the text color of the chip in the chip group.
Declaration
public Color ChipTextColor { get; set; }
Property Value
Type |
---|
Xamarin.Forms.Color |
ChipTextSize
Gets or sets the value of ChipTextSize. This property can be used to change the text size for the chip in the chip group.
Declaration
public double ChipTextSize { get; set; }
Property Value
Type |
---|
System.Double |
ChoiceMode
Gets or sets a value that indicates the selection mode of chip item in the Choice type.
Declaration
public ChoiceMode ChoiceMode { get; set; }
Property Value
Type | Description |
---|---|
ChoiceMode | The default value is Single. |
Remarks
This property is applicable for Choice only.
CloseButtonColor
Gets or sets the value of CloseButtonColor. Using this proprty, you can change the color of the close button in chip.
Declaration
public Color CloseButtonColor { get; set; }
Property Value
Type |
---|
Xamarin.Forms.Color |
Command
Gets or sets the value of command. This property can be used to give command to chip group.
Declaration
public ICommand Command { get; set; }
Property Value
Type |
---|
System.Windows.Input.ICommand |
DisplayMemberPath
Gets or sets the value of DisplayMemberPath, which is member path value of the display text in chip.
Declaration
public string DisplayMemberPath { get; set; }
Property Value
Type |
---|
System.String |
ImageMemberPath
Gets or sets the value of ImageMemberPath. It is a member path for icon image of the chip in a chip group.
Declaration
public string ImageMemberPath { get; set; }
Property Value
Type | Description |
---|---|
System.String | This property takes the string as its value. |
InputView
Gets or sets the value of InputView. This property can be used to set input view or editor in the Input Chip group.
Declaration
public View InputView { get; set; }
Property Value
Type |
---|
Xamarin.Forms.View |
ItemHeight
Gets or sets the value of the ItemHeight. This property can be used to customize the height of the chips in group.
Declaration
public double ItemHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The height of the item. |
Items
Gets or sets the value of the ChipCollection. This chip collection of SfChip is used to generate the chips in ChipGroup.
Declaration
public ChipCollection Items { get; set; }
Property Value
Type |
---|
ChipCollection |
ItemsSource
Gets or sets the value of ItemsSource. It is a collection of items to generate the chips in ChipGroup.
Declaration
public IList ItemsSource { get; set; }
Property Value
Type |
---|
System.Collections.IList |
ItemTemplate
Gets or sets the value of ItemTemplate. This property can be used to set custom content for data item in the chip group control.
Declaration
public DataTemplate ItemTemplate { get; set; }
Property Value
Type |
---|
Xamarin.Forms.DataTemplate |
SelectedChipBackgroundColor
Gets or sets the value of SelectedChipBackgroundColor. This property can be used to change the background color for a selected chip in the chip group.
Declaration
public Color SelectedChipBackgroundColor { get; set; }
Property Value
Type |
---|
Xamarin.Forms.Color |
SelectedChipTextColor
Gets or sets the value of SelectedChipTextColor. This property can be used to change the the text color for the selected chip in the chip group.
Declaration
public Color SelectedChipTextColor { get; set; }
Property Value
Type |
---|
Xamarin.Forms.Color |
SelectedItem
Gets or sets the value of SelectedItem. This property can be used to select a particular item in the Choice Chip group.
Declaration
public object SelectedItem { get; set; }
Property Value
Type |
---|
System.Object |
SelectedItems
Gets or sets the value of the SelectedItems. This property can be used to select a particular item in the Filter chip group.
Declaration
public IList SelectedItems { get; set; }
Property Value
Type |
---|
System.Collections.IList |
SelectionIndicatorColor
Gets or sets the value of SelectionIndicatorColor. Using this proprty, you can change the color of the selection indicator in chip.
Declaration
public Color SelectionIndicatorColor { get; set; }
Property Value
Type |
---|
Xamarin.Forms.Color |
ShowIcon
Gets or sets a value indicating whether icon is shown in chips. Icon is in the visible state when the ShowIcon property is true, otherwise icons will be collapsed.
Declaration
public bool ShowIcon { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Type
Gets or sets the value of Type. This property can be used to set the type of the chips in the chip group.
Declaration
public SfChipsType Type { get; set; }
Property Value
Type |
---|
SfChipsType |
Methods
Dispose()
This method releases all resources used by the SfChipGroup object.
Declaration
public void Dispose()
Remarks
Call Dispose() when you are finished using the SfChipGroup. The Dispose() method leaves the SfChipGroup in an unusable state. After calling Dispose(), you must release all references to the SfChipGroup so the garbage collector can reclaim the memory that the SfChipGroup was occupying.
Dispose(Boolean)
Dispose the specified disposing.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing | If set to |
GetChips()
This method returns a read-only collection of chips in SfChipGroup.
Declaration
public ReadOnlyCollection<SfChip> GetChips()
Returns
Type | Description |
---|---|
System.Collections.ObjectModel.ReadOnlyCollection<SfChip> | The children. |
Events
ChipClicked
Clicked event handler for chip.
Declaration
public event EventHandler<EventArgs> ChipClicked
Event Type
Type |
---|
System.EventHandler<System.EventArgs> |
ItemRemoved
Occurs when the user clicked the close button in SfChipGroup.
Declaration
public event EventHandler<ItemRemovedEventArgs> ItemRemoved
Event Type
Type |
---|
System.EventHandler<ItemRemovedEventArgs> |
Remarks
This event support for Input type SfChipGroup only.
SelectionChanged
Occurs when the user selects an item from unselected items.
Declaration
public event EventHandler<SelectionChangedEventArgs> SelectionChanged
Event Type
Type |
---|
System.EventHandler<SelectionChangedEventArgs> |
SelectionChanging
Occurs when the user selects an item from unselected items.
Declaration
public event EventHandler<SelectionChangingEventArgs> SelectionChanging
Event Type
Type |
---|
System.EventHandler<SelectionChangingEventArgs> |