Skip to main content

ChipGroup Members

A base class for chip groups.

Constructors

Name Description
ChipGroup() Initializes a new instance of the ChipGroup class.

Fields

Name Description
AnchorXProperty static Bindable property for AnchorX. Inherited from VisualElement.
AnchorYProperty static Bindable property for AnchorY. Inherited from VisualElement.
AutomationIdProperty static Bindable property for AutomationId. Inherited from Element.
BackgroundColorProperty static Bindable property for BackgroundColor. Inherited from VisualElement.
BackgroundProperty static Bindable property for Background. Inherited from VisualElement.
BehaviorsProperty static Bindable property for Behaviors. Inherited from VisualElement.
BindingContextProperty static Bindable property for BindingContext. Inherited from BindableObject.
BoxModeProperty static Identifies the BoxMode bindable property.
ChipBackgroundColorProperty static Identifies the ChipBackgroundColor bindable property.
ChipBorderColorProperty static Identifies the ChipBorderColor bindable property.
ChipBorderThicknessProperty static Identifies the ChipBorderThickness bindable property.
ChipCheckIconColorProperty static Identifies the ChipCheckIconColor bindable property.
ChipCheckIconProperty static Identifies the ChipCheckIcon bindable property.
ChipContentTemplateProperty static Identifies the ChipContentTemplate bindable property.
ChipCornerRadiusProperty static Identifies the ChipCornerRadius bindable property.
ChipDisabledBackgroundColorProperty static Identifies the ChipDisabledBackgroundColor bindable property.
ChipDisabledBorderColorProperty static Identifies the ChipDisabledBorderColor bindable property.
ChipDisabledCheckIconColorProperty static Identifies the ChipDisabledCheckIconColor bindable property.
ChipDisabledIconColorProperty static Identifies the ChipDisabledIconColor bindable property.
ChipDisabledRemoveIconColorProperty static Identifies the ChipDisabledRemoveIconColor bindable property.
ChipDisabledTextColorProperty static Identifies the ChipDisabledTextColor bindable property.
ChipDoubleTapCommandProperty static Identifies the ChipDoubleTapCommand bindable property.
ChipFontAttributesProperty static Identifies the ChipFontAttributes bindable property.
ChipFontFamilyProperty static Identifies the ChipFontFamily bindable property.
ChipFontSizeProperty static Identifies the ChipFontSize bindable property.
ChipIconColorProperty static Identifies the ChipIconColor bindable property.
ChipIconIndentProperty static Identifies the ChipIconIndent bindable property.
ChipIconSizeProperty static Identifies the ChipIconSize bindable property.
ChipIsIconVisibleProperty static Identifies the ChipIsIconVisible bindable property.
ChipLongPressCommandProperty static Identifies the ChipLongPressCommand bindable property.
ChipPaddingProperty static Identifies the ChipPadding bindable property.
ChipPressedBackgroundColorProperty static Identifies the ChipPressedBackgroundColor bindable property.
ChipPressedBorderColorProperty static Identifies the ChipPressedBorderColor bindable property.
ChipPressedCheckIconColorProperty static Identifies the ChipPressedCheckIconColor bindable property.
ChipPressedIconColorProperty static Identifies the ChipPressedIconColor bindable property.
ChipPressedRemoveIconColorProperty static Identifies the ChipPressedRemoveIconColor bindable property.
ChipPressedTextColorProperty static Identifies the ChipPressedTextColor bindable property.
ChipRemoveIconClickedCommandProperty static Identifies the ChipRemoveIconClickedCommand bindable property.
ChipRemoveIconColorProperty static Identifies the ChipRemoveIconColor bindable property.
ChipRemoveIconProperty static Identifies the ChipRemoveIcon bindable property.
ChipRoundedIconProperty static Identifies the ChipRoundedIcon bindable property.
ChipTapCommandProperty static Identifies the ChipTapCommand bindable property.
ChipTextColorProperty static Identifies the ChipTextColor bindable property.
ChipUseRippleEffectProperty static Identifies the ChipUseRippleEffect bindable property.
ClassIdProperty static Bindable property for ClassId. Inherited from Element.
ClipProperty static Bindable property for Clip. Inherited from VisualElement.
DisplayMemberProperty static Identifies the DisplayMember bindable property.
FlowDirectionProperty static Bindable property for FlowDirection. Inherited from VisualElement.
FontAutoScalingEnabledProperty static Identifies the FontAutoScalingEnabled bindable property.
HeightProperty static Bindable property for Height. Inherited from VisualElement.
HeightRequestProperty static Bindable property for HeightRequest. Inherited from VisualElement.
HorizontalOptionsProperty static Bindable property for HorizontalOptions. Inherited from View.
HorizontalSpacingProperty static Identifies the HorizontalSpacing bindable property.
IconMemberProperty static Identifies the IconMember bindable property.
InputTransparentProperty static Bindable property for InputTransparent. Inherited from VisualElement.
IsEnabledProperty static Bindable property for IsEnabled. Inherited from VisualElement.
IsFocusedProperty static Bindable property for IsFocused. Inherited from VisualElement.
IsFocusedPropertyKey static Bindable property for IsFocused. Inherited from VisualElement.
IsMultilineProperty static Identifies the IsMultiline bindable property.
IsScrollBarVisibleProperty static Identifies the IsScrollBarVisible bindable property.
IsVisibleProperty static Bindable property for IsVisible. Inherited from VisualElement.
ItemsSourceProperty static Identifies the ItemsSource bindable property.
MarginProperty static Bindable property for Margin. Inherited from View.
MinimumHeightRequestProperty static Bindable property for MinimumHeightRequest. Inherited from VisualElement.
MinimumWidthRequestProperty static Bindable property for MinimumWidthRequest. Inherited from VisualElement.
NavigationProperty static Bindable property for Navigation. Inherited from VisualElement.
OpacityProperty static Bindable property for Opacity. Inherited from VisualElement.
PaddingProperty static Identifies the Padding bindable property.
propertyMapper protected Represents the view’s internal PropertyMapper. Inherited from View.
RotationProperty static Bindable property for Rotation. Inherited from VisualElement.
RotationXProperty static Bindable property for RotationX. Inherited from VisualElement.
RotationYProperty static Bindable property for RotationY. Inherited from VisualElement.
ScaleProperty static Bindable property for Scale. Inherited from VisualElement.
ScaleXProperty static Bindable property for ScaleX. Inherited from VisualElement.
ScaleYProperty static Bindable property for ScaleY. Inherited from VisualElement.
StyleProperty static Bindable property for Style. Inherited from VisualElement.
TranslationXProperty static Bindable property for TranslationX. Inherited from VisualElement.
TranslationYProperty static Bindable property for TranslationY. Inherited from VisualElement.
TriggersProperty static Bindable property for Triggers. Inherited from VisualElement.
VerticalOptionsProperty static Bindable property for VerticalOptions. Inherited from View.
VerticalSpacingProperty static Identifies the VerticalSpacing bindable property.
VisualProperty static Bindable property for Visual. Inherited from VisualElement.
WidthProperty static Bindable property for Width. Inherited from VisualElement.
WidthRequestProperty static Bindable property for WidthRequest. Inherited from VisualElement.
XProperty static Bindable property for X. Inherited from VisualElement.
YProperty static Bindable property for Y. Inherited from VisualElement.

Properties

Name Description
ActualAppearance Gets the common appearance settings that are applied to the current ChipGroup.
AnchorX Gets or sets the X component of the center point for any transform operation, relative to the bounds of the element. This is a bindable property. Inherited from VisualElement.
AnchorY Gets or sets the Y component of the center point for any transform operation, relative to the bounds of the element. This is a bindable property. Inherited from VisualElement.
AutomationId Gets or sets a value that allows the automation framework to find and interact with this element. Inherited from Element.
Background Gets or sets the Brush which will be used to fill the background of an element. This is a bindable property. Inherited from VisualElement.
BackgroundColor Gets or sets the Color which will fill the background of an element. This is a bindable property. Inherited from VisualElement.
Batched Gets a value that indicates there are batched changes done for this element. Inherited from VisualElement.
Behaviors Gets the list of Behavior objects associated to this element. This is a read-only bindable property. Inherited from VisualElement.
BindingContext

Gets or sets an object that contains the properties that will be targeted by the bound properties that belong to this BindableObject. This is a bindable property.

Inherited from BindableObject.
Bounds Gets the bounds of the element in device-independent units. Inherited from VisualElement.
BoxMode Gets or sets whether chips in this group are filled or outlined. This is a bindable property.
ChipBackgroundColor Gets or sets the background color for chips in this group when they are in the normal state. This is a bindable property.
ChipBorderColor Gets or sets the border color for chips when they are in the normal state. This is a bindable property.
ChipBorderThickness Gets or sets the border thickness for chips in this group. This is a bindable property.
ChipCheckIcon Gets or sets the check icon. This is a bindable property.
ChipCheckIconColor Gets or sets the color of the check icon for chips in this group. This is a bindable property.
ChipContentTemplate Gets or sets a content template of chips in the group. This is a bindable property.
ChipCornerRadius Gets or sets a corner radius for chips in this group. This is a bindable property.
ChipDisabledBackgroundColor Gets or sets the background color for chips in this group when they are disabled. This is a bindable property.
ChipDisabledBorderColor Gets or sets the border color for chips in this group when they are disabled. This is a bindable property.
ChipDisabledCheckIconColor Gets or sets the check icon’s color for chips in this group when they are disabled. This is a bindable property.
ChipDisabledIconColor Gets or sets the icon color for chips in this group when they are disabled. This is a bindable property.
ChipDisabledRemoveIconColor Gets or sets the remove icon color for chips in this group when they are disabled. This is a bindable property.
ChipDisabledTextColor Gets or sets the text color for chips in this group when they are disabled. This is a bindable property.
ChipDoubleTapCommand Gets or sets a command executed when a user double-taps a chip in this group. This is a bindable property.
ChipFontAttributes Gets or sets whether the font used to display text is bold, italic, or unmodified. This is a bindable property.
ChipFontFamily Gets or sets the font family name for chips in this group. This is a bindable property.
ChipFontSize Gets or sets the font size for chips in this group. This is a bindable property.
ChipIconColor Gets or sets the icon color for chips in this group. This is a bindable property.
ChipIconIndent Gets or sets the indent of the icon from text for chips in this group. This is a bindable property.
ChipIconSize Gets or sets the icon size. This is a bindable property.
ChipIsIconVisible Gets or sets whether chips in this group display an icon. This is a bindable property.
ChipLongPressCommand Gets or sets a command executed when a user taps and holds a chip in this group. This is a bindable property.
ChipPadding Gets or sets an amount of space around chips in this group. This is a bindable property.
ChipPressedBackgroundColor Gets or sets the background color for chips in this group when they are pressed. This is a bindable property.
ChipPressedBorderColor Gets or sets the border color for chips in this group when they are pressed. This is a bindable property.
ChipPressedCheckIconColor Gets or sets the check icon’s color for chips in this group when they are pressed. This is a bindable property.
ChipPressedIconColor Gets or sets the icon color for chips in this group when they are pressed. This is a bindable property.
ChipPressedRemoveIconColor Gets or sets the remove icon’s color for chips in this group when they are pressed. This is a bindable property.
ChipPressedTextColor Gets or sets the text color for chips in this group when they are pressed. This is a bindable property.
ChipRemoveIcon Gets or sets the remove icon. This is a bindable property.
ChipRemoveIconClickedCommand Gets or sets a command executed when a user clicks the remove icon in a chip in this group. This is a bindable property.
ChipRemoveIconColor Gets or sets the remove icon’s color for chips in this group. This is a bindable property.
ChipRoundedIcon Gets or sets whether chip icons in this group are rounded. This is a bindable property.
Chips Provides access to the collection of chips displayed in this group.
ChipTapCommand Gets or sets a command executed when a user taps a chip in this group. This is a bindable property.
ChipTextColor Gets or sets the text color for chips in this group. This is a bindable property.
ChipUseRippleEffect Gets or sets whether the chip groups displays a ripple effect when a user (un)selects a chip in this group. This is a bindable property.
class Gets or sets the style classes for the element. Inherited from NavigableElement.
ClassId Gets or sets a value used to identify a collection of semantically similar elements. Inherited from Element.
Clip Specifies the clipping region for an element. This is a bindable property. Inherited from VisualElement.
DesiredSize Gets the size that this element computed during the measure pass of the layout process. Inherited from VisualElement.
DisableLayout Gets a value that indicates that layout for this element is disabled. Inherited from VisualElement.
Dispatcher

Gets the dispatcher that was available when this bindable object was created, otherwise tries to find the nearest available dispatcher (probably the window’s/app’s).

Inherited from BindableObject.
DisplayMember Gets or sets the data field that specifies the text displayed in chips in this group. This is a bindable property.
EffectControlProvider For internal use by .NET MAUI. Inherited from Element.
Effects Gets or sets the styles and properties that will be applied to the element during runtime. Inherited from Element.
FlowDirection Gets or sets the layout flow direction. This is a bindable property. Inherited from VisualElement.
FontAutoScalingEnabled Gets or sets whether text is scaled according to the operating system’s text scale setting. This is a bindable property.
Frame Gets or sets the frame this element resides in on screen. Inherited from VisualElement.
GestureRecognizers The collection of gesture recognizers associated with this view. Inherited from View.
Handler Gets or sets the IViewHandler associated to this element. Inherited from VisualElement.
Height Gets the current rendered height of this element. This is a read-only bindable property. Inherited from VisualElement.
HeightRequest Gets or sets the desired height override of this element. This is a bindable property. Inherited from VisualElement.
HorizontalOptions Gets or sets the LayoutOptions that define how the element gets laid out in a layout cycle. This is a bindable property. Inherited from View.
HorizontalSpacing Gets or sets the horizontal amount of space between chips in this group. This is a bindable property.
IconMember Gets or sets the data field that specifies the icon displayed in chips in this group. This is a bindable property.
Id Gets a value that can be used to uniquely identify an element throughout the run of your application. Inherited from Element.
InputTransparent Gets or sets a value indicating whether this element responds to hit testing during user interaction. This is a bindable property. Inherited from VisualElement.
IsEnabled Gets or sets a value indicating whether this element is enabled in the user interface. This is a bindable property. Inherited from VisualElement.
IsFocused Gets a value indicating whether this element is focused currently. This is a bindable property. Inherited from VisualElement.
IsMultiline Gets or sets whether chips in this group are displayed in single or multiple lines. This is a bindable property.
IsPlatformEnabled Gets or sets a value that indicates whether this elements’s platform equivalent element is enabled. Inherited from VisualElement.
IsScrollBarVisible Gets or sets whether the scroll bar is displayed. This is a bindable property.
IsVisible Gets or sets a value that determines whether this element will be visible on screen and take up space in layouts. This is a bindable property. Inherited from VisualElement.
ItemsSource Gets or sets a data source that contains chips for this group. Use the DisplayMember and IconMember properties to specify data source fields that contain the text and icon for chips. This is a bindable property.
LogicalChildren For internal use by the Microsoft.Maui.Controls platform. Inherited from Element.
Margin Gets or set the margin for the view. Inherited from View.
MinimumHeightRequest Gets or sets the minimum height the element will request during layout. This is a bindable property. Inherited from VisualElement.
MinimumWidthRequest Gets or sets the minimum width the element will request during layout. This is a bindable property. Inherited from VisualElement.
Navigation Gets the object responsible for handling stack-based navigation. Inherited from NavigableElement.
NavigationProxy Gets the cast of Navigation to a NavigationProxy. Inherited from NavigableElement.
Opacity Gets or sets the opacity value applied to the element when it is rendered. The range of this value is 0 to 1; values outside this range will be set to the nearest valid value. This is a bindable property. Inherited from VisualElement.
Padding Gets or sets the amount of space around this group. This is a bindable property.
Parent Gets or sets the parent Element of this element. Inherited from Element.
RealParent For internal use by .NET MAUI. Inherited from Element.
Resources Gets or sets the local resource dictionary. Inherited from VisualElement.
Rotation Gets or sets the rotation (in degrees) about the Z-axis (affine rotation) when the element is rendered. This is a bindable property. Inherited from VisualElement.
RotationX Gets or sets the rotation (in degrees) about the X-axis (perspective rotation) when the element is rendered. This is a bindable property. Inherited from VisualElement.
RotationY Gets or sets the rotation (in degrees) about the Y-axis (perspective rotation) when the element is rendered. This is a bindable property. Inherited from VisualElement.
Scale Gets or sets the scale factor applied to the element. This is a bindable property. Inherited from VisualElement.
ScaleX Gets or sets a scale value to apply to the X direction. This is a bindable property. Inherited from VisualElement.
ScaleY Gets or sets a scale value to apply to the Y direction. This is a bindable property. Inherited from VisualElement.
Style Gets or sets the unique Style for this element. Inherited from NavigableElement.
StyleClass Gets or sets the style classes for the element. Inherited from NavigableElement.
StyleId Gets or sets a user defined value to uniquely identify the element. Inherited from Element.
TranslationX Gets or sets the X translation delta of the element. This is a bindable property. Inherited from VisualElement.
TranslationY Gets or sets the Y translation delta of the element. This is a bindable property. Inherited from VisualElement.
Triggers Gets the list of TriggerBase objects associated to this element. This is a read-only bindable property. Inherited from VisualElement.
VerticalOptions Gets or sets the LayoutOptions that define how the element gets laid out in a layout cycle. This is a bindable property. Inherited from View.
VerticalSpacing Gets or sets the vertical amount of space between chips in this group when they are arranged in multiple rows. This is a bindable property.
Visual Gets or sets a IVisual implementation that overrides the visual appearance of an element. This is a bindable property. Inherited from VisualElement.
Width Gets the current width of this element. This is a read-only bindable property. Inherited from VisualElement.
WidthRequest Gets or sets the desired width override of this element. This is a bindable property. Inherited from VisualElement.
X Gets the current X position of this element. This is a read-only bindable property. Inherited from VisualElement.
Y Gets the current Y position of this element. This is a read-only bindable property. Inherited from VisualElement.

Methods

Name Description
ApplyBindings() protected Applies all the current bindings to BindingContext. Inherited from BindableObject.
BatchBegin() Signals the start of a batch of changes to the elements properties. This can benefit performance if a bigger number of property values are changed. Inherited from VisualElement.
BatchCommit() Signals the end of a batch of commands to the element and that those commands should now be committed. Inherited from VisualElement.
ChangeVisualState() protected Changes the current visual state based on this elements current property values. Inherited from VisualElement.
ClearValue(BindableProperty) Clears any value that is previously set for a bindable property. Inherited from BindableObject.
ClearValue(BindablePropertyKey) Clears any value that is previously set for a bindable property, identified by its key. Inherited from BindableObject.
CoerceValue(BindableProperty)

Coerces the value of the specified bindable property. This is done by invoking BindableProperty.CoerceValueDelegate of the specified bindable property.

Inherited from BindableObject.
CoerceValue(BindablePropertyKey)

Coerces the value of the specified bindable property. This is done by invoking BindableProperty.CoerceValueDelegate of the specified bindable property.

Inherited from BindableObject.
Dispose() Disposes unmanaged resources.
EffectIsAttached(String) For internal use by .NET MAUI. Inherited from Element.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from System.Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from System.Object.
FindByName(String) Returns the element that has the specified name. Inherited from Element.
Focus() Attempts to set focus to this element. Inherited from VisualElement.
GetChildElements(Point) Gets the child elements that are visually beneath the specified point. Inherited from View.
GetChipByItem(Object) Returns a chip by a view model object based on which the chip is created.
GetHashCode() Serves as the default hash function. Inherited from System.Object.
GetType() Gets the Type of the current instance. Inherited from System.Object.
GetValue(BindableProperty) Returns the value that is contained in the given bindable property. Inherited from BindableObject.
InvalidateMeasure() protected Marks the current measure of an element as invalidated. Inherited from VisualElement.
InvalidateMeasureNonVirtual(InvalidationTrigger) Invalidates the measure of an element. Inherited from VisualElement.
InvalidateMeasureOverride() protected Provides a way to allow subclasses (e.g., Layout) to override InvalidateMeasure() Inherited from VisualElement.
IsSet(BindableProperty) Determines whether or not a bindable property exists and has a value set. Inherited from BindableObject.
Measure(Double, Double, MeasureFlags) Returns the minimum size that an element needs in order to be displayed on the device. Inherited from VisualElement.
MeasureOverride(Double, Double) protected Allows subclasses to implement custom Measure logic during a controls measure pass. Inherited from VisualElement.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from System.Object.
IElementController.SetValueFromRenderer(BindableProperty, Object) For internal use by .NET MAUI. Inherited from Element.
OnBindingContextChanged() protected Invoked whenever the binding context of the View changes. Inherited from View.
OnChildAdded(Element) protected Invoked when a child object is added to this element. Inherited from VisualElement.
OnChildRemoved(Element, Int32) protected Invoked when a child object is removed from this element. Inherited from VisualElement.
OnChildrenReordered() protected Raises the ChildrenReordered event. Inherited from VisualElement.
OnMeasure(Double, Double) protected Method that is called when a layout measurement happens. Inherited from VisualElement.
OnParentSet() protected Raises the (internal) ParentSet event. Inherited from NavigableElement.
OnPropertyChanging(String) protected Raises the PropertyChanging event. Inherited from BindableObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from System.Object.
RefreshData() Updates text and icons in chips in this group based on the bound data source.
RemoveBinding(BindableProperty) Removes a previously set binding from a bindable property. Inherited from BindableObject.
RemoveDynamicResource(BindableProperty) Removes a previously set dynamic resource. Inherited from Element.
SelectChip(Chip) Selects the specified chip.
SelectChipAtIndex(Int32) Selects a chip with the specified index in the bound data source.
SetBinding(BindableProperty, BindingBase) Assigns a binding to a bindable property. Inherited from BindableObject.
SetDynamicResource(BindableProperty, String) Sets the BindableProperty property of this element to be updated via the DynamicResource with the provided key. Inherited from Element.
SetInheritedBindingContext(BindableObject, Object) static Sets the inherited context to a nested element. Inherited from BindableObject.
SetValue(BindableProperty, Object) Sets the value of the specified bindable property. Inherited from BindableObject.
SetValue(BindablePropertyKey, Object) Sets the value of the specified bindable property. Inherited from BindableObject.
SetValueCore(BindableProperty, Object, SetValueFlags) For internal use by the Microsoft.Maui.Controls platform. Inherited from BindableObject.
SetValueFromRenderer(BindableProperty, Object) For internal use by .NET MAUI. Inherited from Element.
SetValueFromRenderer(BindablePropertyKey, Object) For internal use by .NET MAUI. Inherited from Element.
SizeAllocated(Double, Double) protected Method that is called during a layout cycle to signal the start of a sub-tree layout. Inherited from VisualElement.
ToString() Returns a string that represents the current object. Inherited from System.Object.
UnapplyBindings() protected Removes all current bindings from the current context. Inherited from BindableObject.
Unfocus() Unsets keyboard focus on this element. Inherited from VisualElement.

Events

Name Description
BatchCommitted Occurs when a batch of property changes have been committed by calling BatchCommit(). Inherited from VisualElement.
BindingContextChanged Occurs when the value of the BindingContext property changes. Inherited from BindableObject.
ChildAdded Raised whenever a child element is added to the element. Inherited from Element.
ChildRemoved Raised whenever a child element is removed from the element. Inherited from Element.
ChildrenReordered Occurs when the order of this element’s children changes. Inherited from VisualElement.
ChipDoubleTap Fires when a user double-taps a chip in this group.
ChipGeneration Fires before a chip is generated based on the bound view model and allows you to customize the chip.
ChipLongPress Fires when a user taps and holds a chip in this group.
ChipRemoveIconClicked Fires when a user clicks the Remove icon in a chip in this group.
ChipTap Fires when a user taps a chip in this group.
DescendantAdded Raised whenever a child element is added to the element’s subtree. Inherited from Element.
DescendantRemoved Raised whenever a child element is removed from the elements subtree. Inherited from Element.
FocusChangeRequested Occurs when a focus change is requested. Inherited from VisualElement.
Focused Occurs when this element is focused. Inherited from VisualElement.
MeasureInvalidated Occurs when the current measure of an element has been invalidated. Inherited from VisualElement.
PropertyChanged Occurs when a property value changes. Inherited from BindableObject.
PropertyChanging Occurs when a property value is changing. Inherited from BindableObject.
SizeChanged Occurs when the size of an element changed. Inherited from VisualElement.
Unfocused Occurs when this element is unfocused. Inherited from VisualElement.
See Also