BaseShellItem Class

Reference

Definition

Namespace:: Microsoft.Maui.Controls

Assembly:: Microsoft.Maui.Controls.dll

Source:: BaseShellItem.cs

Source:: BaseShellItem.cs

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.

public ref class BaseShellItem : Microsoft::Maui::Controls::NavigableElement

public class BaseShellItem : Microsoft.Maui.Controls.NavigableElement

type BaseShellItem = class
    inherit NavigableElement

Public Class BaseShellItem
Inherits NavigableElement

Inheritance: Object

BindableObject

Element

NavigableElement
BaseShellItem

Derived: Microsoft.Maui.Controls.ShellContent

Microsoft.Maui.Controls.ShellGroupItem

Constructors

BaseShellItem()

Fields

FlyoutIconProperty	Bindable property for FlyoutIcon.
IconProperty	Bindable property for Icon.
IsCheckedProperty	Bindable property for IsChecked.
IsEnabledProperty	Bindable property for IsEnabled.
IsVisibleProperty	Bindable property for IsVisible.
TitleProperty	Bindable property for Title.
WindowProperty	Bindable property for Window.

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 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)
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)
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)
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)
FlyoutIcon	The icon to use for the item. If this property is unset, it will fallback to using the Icon property value.
FlyoutItemIsVisible
Handler	Gets or sets the associated handler for this element. (Inherited from Element)
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 throughout the run of your 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.
IsVisible
LogicalChildren	Obsolete. (Inherited from Element)
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)
Parent	Gets or sets the parent Element of this element. (Inherited from Element)
RealParent	For internal use by .NET MAUI. (Inherited from Element)
Route	The string used to address the item.
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)
Title	Title to display in the UI.
Window

Methods

AddLogicalChild(Element)	Adds an Element to the logical children. (Inherited from Element)
ApplyBindings()	Applies all the current bindings to BindingContext. (Inherited from BindableObject)
ClearLogicalChildren()	Removes all child Elements. (Inherited from Element)
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)
EffectIsAttached(String)	For internal use by .NET MAUI. (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 given bindable property. (Inherited from BindableObject)
InsertLogicalChild(Int32, Element)	Inserts an Element to the logical children at the specified index. (Inherited from Element)
IsSet(BindableProperty)	Determines whether or not a bindable property exists and has a value 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)	Raises the ChildAdded event. Implement this method to add class handling for this event. (Inherited from Element)
OnChildRemoved(Element, Int32)	Raises the ChildRemoved event. Implement this method to add class handling for this event (Inherited from Element)
OnDisappearing()
OnHandlerChanged()	When overridden in a derived class, should raise the HandlerChanged event. (Inherited from Element)
OnHandlerChanging(HandlerChangingEventArgs)	When overridden in a derived class, should raise the HandlerChanging event. (Inherited from Element)
OnParentChanged()	When overridden in a derived class, should raise the ParentChanged event. (Inherited from Element)
OnParentChanging(ParentChangingEventArgs)	When overridden in a derived class, should raise the ParentChanging event. (Inherited from Element)
OnParentSet()	Raises the (internal) `ParentSet` event. (Inherited from NavigableElement)
OnPropertyChanged(String)
OnPropertyChanging(String)	Raises the PropertyChanging event. (Inherited from BindableObject)
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)
RemoveLogicalChild(Element)	Removes the first occurrence of a specific Element from the logical children. (Inherited from Element)
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)
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)
SetValueFromRenderer(BindableProperty, Object)	For internal use by .NET MAUI. (Inherited from Element)
SetValueFromRenderer(BindablePropertyKey, Object)	For internal use by .NET MAUI. (Inherited from Element)
UnapplyBindings()	Removes all current bindings from the current context. (Inherited from BindableObject)

Events

Appearing
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)
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)
Disappearing
HandlerChanged	Raised whenever the element's handler has changed. (Inherited from Element)
HandlerChanging	Raised whenever the element's handler starts to change. (Inherited from Element)
ParentChanged	Raised whenever the element's parent has changed. (Inherited from Element)
ParentChanging	Raised whenever the element's starts to change. (Inherited from Element)
PropertyChanged	Occurs when a property value changes. (Inherited from BindableObject)
PropertyChanging	Occurs when a property value is changing. (Inherited from BindableObject)

Explicit Interface Implementations

IContextFlyoutElement.ContextFlyout	Gets the ContextFlyout for the view. Menu flyouts, menu flyout subitems, and menu flyout separators can be added to the context flyout. (Inherited from Element)
IDynamicResourceHandler.SetDynamicResource(BindableProperty, String)	(Inherited from BindableObject)
IEffectControlProvider.RegisterEffect(Effect)	Registers the specified `effect` to this element. (Inherited from Element)
IElement.Parent	Gets the Parent of the Element. (Inherited from Element)
IElementController.Descendants()	For internal use by .NET MAUI. (Inherited from Element)
IElementController.LogicalChildren	For internal use by .NET MAUI. (Inherited from Element)
IElementController.SetValueFromRenderer(BindableProperty, Object)	For internal use by .NET MAUI. (Inherited from Element)
INameScope.RegisterName(String, Object)	For internal use by .NET MAUI. (Inherited from Element)
INameScope.UnregisterName(String)	For internal use by .NET MAUI. (Inherited from Element)
IToolTipElement.ToolTip	Represents a small rectangular pop-up window that displays a brief description of a view's purpose when the user rests the pointer on the view. (Inherited from Element)
IVisualTreeElement.GetVisualChildren()	Gets a readonly list of the element's visual children. (Inherited from Element)
IVisualTreeElement.GetVisualParent()	Gets the element's visual parent. (Inherited from Element)

Extension Methods

GetPropertyIfSet<T>(BindableObject, BindableProperty, T)
SetAppTheme<T>(BindableObject, BindableProperty, T, T)
SetAppThemeColor(BindableObject, BindableProperty, Color, Color)
SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String)	Creates and applies a binding to a property.
SetBinding<TSource,TProperty>(BindableObject, BindableProperty, Func<TSource,TProperty>, BindingMode, IValueConverter, Object, String, Object, Object, Object)	Creates a binding between a property on the source object and a property on the target object.
FindByName<T>(Element, String)
ToHandler(IElement, IMauiContext)
ToPlatform(IElement, IMauiContext)
GetVisualElementWindow(IVisualTreeElement)	Gets the Window containing the Visual Tree Element, if the element is contained within one.
GetVisualTreeDescendants(IVisualTreeElement)	Gets the entire hierarchy of descendants as a list of children for a given Visual Tree Element.
GetVisualTreeElements(IVisualTreeElement, Point)	Gets list of a Visual Tree Element's children based off of a given Point.
GetVisualTreeElements(IVisualTreeElement, Rect)	Gets list of a Visual Tree Elements children based off of a rectangle.
GetVisualTreeElements(IVisualTreeElement, Double, Double, Double, Double)	Gets list of a Visual Tree Elements children based off of a rectangle defined by its coordinates which are specified in platform units, not pixels.
GetVisualTreeElements(IVisualTreeElement, Double, Double)	Gets list of a Visual Tree Elements children based off of a given x, y point.

Applies to

Share via