ShellItem Class

Definition

Namespace:

Xamarin.Forms

Assembly:

Xamarin.Forms.Core.dll

One or more items in the flyout. Contained within a Shell.

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]
[Xamarin.Forms.ContentProperty("Items")]
public class ShellItem : Xamarin.Forms.ShellGroupItem, Xamarin.Forms.IElementConfiguration<Xamarin.Forms.ShellItem>, Xamarin.Forms.IShellItemController

type ShellItem = class
    inherit ShellGroupItem
    interface IShellItemController
    interface IElementController
    interface IElementConfiguration<ShellItem>

Inheritance

System.Object

BindableObject

Element

NavigableElement

BaseShellItem

ShellGroupItem

ShellItem

Derived

Xamarin.Forms.FlyoutItem

Xamarin.Forms.TabBar

Attributes

System.ComponentModel.EditorBrowsableAttribute ContentPropertyAttribute

Implements

IElementConfiguration<ShellItem> IElementController IShellItemController

Constructors

ShellItem()

Fields

CurrentItemProperty	The backing store for the CurrentItem field.
ItemsProperty	The backing store for the Items field.

Properties

AutomationId	Gets or sets a value that allows the automation framework to find and interact with this element. (Inherited from Element)
BindingContext	Gets or sets object that contains the properties that will be targeted by the bound properties that belong to this BindableObject. (Inherited from BindableObject)
class	(Inherited from NavigableElement)
ClassId	Gets or sets a value used to identify a collection of semantically similar elements. (Inherited from Element)
CurrentItem	The currently selected Tab or ShellSection.
Dispatcher	(Inherited from BindableObject)
EffectControlProvider	For internal use by the Xamarin.Forms platform. (Inherited from Element)
Effects	A list of the effects that are applied to this item. (Inherited from Element)
FlyoutDisplayOptions	AsSingleItem (default) will only display the title of this item in the flyout. AsMultipleItems will create a separate flyout option for each child and MenuItem. (Inherited from ShellGroupItem)
FlyoutIcon	The icon to use for the item. If this property is unset, it will fallback to using the Icon property value. (Inherited from BaseShellItem)
Icon	Defines the icon to display in parts of the chrome that are not the flyout. (Inherited from BaseShellItem)
Id	Gets a value that can be used to uniquely identify an element through the run of an application. (Inherited from Element)
IsChecked	Defines if the item is currently highlighted in the flyout. (Inherited from BaseShellItem)
IsEnabled	Defines if the item is selectable in the chrome. (Inherited from BaseShellItem)
IsTabStop	Indicates whether a FlyoutItem is included in tab navigation. (Inherited from BaseShellItem)
IsVisible	(Inherited from BaseShellItem)
Items	The collection of ShellSection objects managed by thisShellItem.
LogicalChildren	For internal use by the Xamarin.Forms platform. (Inherited from Element)
Navigation	(Inherited from NavigableElement)
NavigationProxy	(Inherited from NavigableElement)
Parent	Gets or sets the parent element of the element. (Inherited from Element)
ParentView	Obsolete. Gets the element which is the closest ancestor of this element that is a VisualElement. (Inherited from Element)
Platform	Obsolete. (Inherited from Element)
RealParent	For internal use by the Xamarin.Forms platform. (Inherited from Element)
Route	The string used to address the item. (Inherited from BaseShellItem)
Style	(Inherited from NavigableElement)
StyleClass	(Inherited from NavigableElement)
StyleId	Gets or sets a user defined value to uniquely identify the element. (Inherited from Element)
TabIndex	Indicates the order in which FlyoutItem objects receive focus when the user navigates through items by pressing the Tab key. (Inherited from BaseShellItem)
Title	Title to display in the UI. (Inherited from BaseShellItem)

Methods

ApplyBindings()	Apply the bindings to BindingContext. (Inherited from BindableObject)
ClearValue(BindableProperty)	Clears any value set by SetValue for property. (Inherited from BindableObject)
ClearValue(BindablePropertyKey)	Clears any value set by SetValue for the property that is identified by propertyKey. (Inherited from BindableObject)
CoerceValue(BindableProperty)	(Inherited from BindableObject)
CoerceValue(BindablePropertyKey)	(Inherited from BindableObject)
Descendants()	For internal use by the Xamarin.Forms platform. (Inherited from Element)
EffectIsAttached(String)	For internal use by the Xamarin.Forms platform. (Inherited from Element)
FindByName(String)	Returns the element that has the specified name. (Inherited from Element)
GetValue(BindableProperty)	Returns the value that is contained in the BindableProperty. (Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty, BindableProperty)	Obsolete. For internal use by the Xamarin.Forms platform. (Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty)	Obsolete. For internal use by the Xamarin.Forms platform. (Inherited from BindableObject)
IsSet(BindableProperty)	Returns true if the target property exists and has been set. (Inherited from BindableObject)
On<T>()
OnAppearing()	(Inherited from BaseShellItem)
OnBindingContextChanged()	Invoked whenever the binding context of the element changes. Implement this method to add class handling for this event. (Inherited from Element)
OnChildAdded(Element)	Developers may override this method to customize behavior when a new Element is added.
OnChildRemoved(Element, Int32)
OnChildRemoved(Element)	Obsolete. Developers may override this method to customize behavior when a child Element is removed.
OnDisappearing()	(Inherited from BaseShellItem)
OnParentSet()	(Inherited from NavigableElement)
OnPropertyChanged(String)	Called whenever a property changes. (Inherited from BaseShellItem)
OnPropertyChanging(String)	Call this method from a child class to notify that a change is going to happen on a property. (Inherited from BindableObject)
OnTabIndexPropertyChanged(Int32, Int32)	Called whenever the TabIndex property changes. (Inherited from BaseShellItem)
OnTabStopPropertyChanged(Boolean, Boolean)	Called whenever the IsTabStop property changes. (Inherited from BaseShellItem)
RemoveBinding(BindableProperty)	Removes a previously set binding. (Inherited from BindableObject)
RemoveDynamicResource(BindableProperty)	Removes a previously set dynamic resource (Inherited from Element)
SetBinding(BindableProperty, BindingBase)	Assigns a binding to a 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)
SetValue(BindableProperty, Object)	Sets the value of the specified property. (Inherited from BindableObject)
SetValue(BindablePropertyKey, Object)	Sets the value of the propertyKey. (Inherited from BindableObject)
SetValueCore(BindableProperty, Object, SetValueFlags)	For internal use by the Xamarin.Forms platform. (Inherited from BindableObject)
SetValueFromRenderer(BindableProperty, Object)	For internal use by the Xamarin.Forms platform. (Inherited from Element)
SetValueFromRenderer(BindablePropertyKey, Object)	For internal use by the Xamarin.Forms platform. (Inherited from Element)
TabIndexDefaultValueCreator()	Called to set the default value of the TabIndex property.. (Inherited from BaseShellItem)
TabStopDefaultValueCreator()	Called to set the default value of the TabStop property. (Inherited from BaseShellItem)
UnapplyBindings()	Unapplies all previously set bindings. (Inherited from BindableObject)

Operators

Implicit(MenuItem to ShellItem)	Used primarily by XAML to implicitly create a MenuItem from a ShellSection .
Implicit(ShellContent to ShellItem)	Used primarily by XAML to implicitly create a ShellItem from a ShellContent .
Implicit(ShellSection to ShellItem)	Used primarily by XAML to implicitly create a ShellItem from a ShellSection .
Implicit(TemplatedPage to ShellItem)	Used primarily by XAML to implicitly create a ShellItem from a TemplatedPage .

Events

Appearing	(Inherited from BaseShellItem)
BindingContextChanged	Raised whenever the BindingContext property changes. (Inherited from BindableObject)
ChildAdded	Occurs whenever a child element is added to the element. (Inherited from Element)
ChildRemoved	Occurs whenever a child element is removed from the element. (Inherited from Element)
DescendantAdded	Occurs whenever a child element is added to the elements subtree. (Inherited from Element)
DescendantRemoved	Occurs whenever a child element is removed from the elements subtree. (Inherited from Element)
Disappearing	(Inherited from BaseShellItem)
PlatformSet	Obsolete. (Inherited from Element)
PropertyChanged	Raised when a property has changed. (Inherited from BindableObject)
PropertyChanging	Raised when a property is about to change. (Inherited from BindableObject)

Explicit Interface Implementations

IDynamicResourceHandler.SetDynamicResource(BindableProperty, String)	For internal use by the Xamarin.Forms platform. (Inherited from BindableObject)
IElementController.SetValueFromRenderer(BindableProperty, Object)	For internal use by the Xamarin.Forms platform. (Inherited from Element)
INameScope.RegisterName(String, Object)	For internal use only. (Inherited from Element)
IShellItemController.GetItems()
IShellItemController.ItemsCollectionChanged
IShellItemController.ProposeSection(ShellSection, Boolean)	For internal use by the Xamarin.Forms platform.
IShellItemController.ShowTabs

Extension Methods

GetPropertyIfSet<T>(BindableObject, BindableProperty, T)
SetAppThemeColor(BindableObject, BindableProperty, Color, Color)
SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String)	Creates and applies a binding to a property.
SetBinding<TSource>(BindableObject, BindableProperty, Expression<Func<TSource,Object>>, BindingMode, IValueConverter, String)	Obsolete. Creates and applies a binding from an expression.
SetOnAppTheme<T>(BindableObject, BindableProperty, T, T)
FindByName<T>(Element, String)	Returns the instance of type T that has name name in the scope that includes element.
FindNextElement(ITabStopElement, Boolean, IDictionary<Int32,List<ITabStopElement>>, Int32)
GetTabIndexesOnParentPage(ITabStopElement, Int32)