BaseShellItem Class

Reference

Definition

Namespace:: Xamarin.Forms

Assembly:: Xamarin.Forms.Core.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A NavigableElement that is the base class for ShellGroupItem and ShellContent.

[System.Diagnostics.DebuggerDisplay("Title = {Title}, Route = {Route}")]
public class BaseShellItem : Xamarin.Forms.NavigableElement, Xamarin.Forms.ITabStopElement

type BaseShellItem = class
    inherit NavigableElement
    interface ITabStopElement

Inheritance: Object

BindableObject

Element

NavigableElement
BaseShellItem

Derived: Xamarin.Forms.ShellContent

Xamarin.Forms.ShellGroupItem

Attributes: DebuggerDisplayAttribute

Implements: ITabStopElement

Constructors

BaseShellItem()

Creates a new BaseShellItem with default values.

Fields

FlyoutIconProperty	The backing store for the FlyoutIcon field.
IconProperty	The backing store for the Icon field.
IsCheckedProperty	The backing store for the IsChecked field.
IsEnabledProperty	The backing store for the IsEnabled field.
IsTabStopProperty	The backing store for the IsTabStopProperty field.
IsVisibleProperty
TabIndexProperty	The backing store for the TabIndexProperty field.
TitleProperty	The backing store for the Title 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)
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)
FlyoutIcon	The icon to use for the item. If this property is unset, it will fallback to using the Icon property value.
Icon	Defines the icon to display in parts of the chrome that are not the flyout.
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.
IsEnabled	Defines if the item is selectable in the chrome.
IsTabStop	Indicates whether a FlyoutItem is included in tab navigation.
IsVisible
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.
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.
Title	Title to display in the UI.

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)	Obsolete. For internal use by the Xamarin.Forms platform. (Inherited from BindableObject)
GetValues(BindableProperty, 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)
OnAppearing()
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)	Invoked whenever the ChildAdded event needs to be emitted. Implement this method to add class handling for this event. (Inherited from Element)
OnChildRemoved(Element)	Obsolete. Invoked whenever the ChildRemoved event needs to be emitted. Implement this method to add class handling for this event. (Inherited from Element)
OnChildRemoved(Element, Int32)	(Inherited from Element)
OnDisappearing()
OnParentSet()	(Inherited from NavigableElement)
OnPropertyChanged(String)	Called whenever a property changes.
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.
OnTabStopPropertyChanged(Boolean, Boolean)	Called whenever the IsTabStop property changes.
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..
TabStopDefaultValueCreator()	Called to set the default value of the TabStop property.
UnapplyBindings()	Unapplies all previously set bindings. (Inherited from BindableObject)

Events

Appearing
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
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)

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)

Applies to