Shell Class
Definition
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 Page that provides fundamental UI features that most applications require, leaving you to focus on the application's core workload.
public ref class Shell : Microsoft::Maui::Controls::Page, Microsoft::Maui::Controls::IPageContainer<Microsoft::Maui::Controls::Page ^>, Microsoft::Maui::Controls::IShellController, Microsoft::Maui::IFlyoutView
[Microsoft.Maui.Controls.ContentProperty("Items")]
public class Shell : Microsoft.Maui.Controls.Page, Microsoft.Maui.Controls.IPageContainer<Microsoft.Maui.Controls.Page>, Microsoft.Maui.Controls.IShellController, Microsoft.Maui.IFlyoutView
[<Microsoft.Maui.Controls.ContentProperty("Items")>]
type Shell = class
inherit Page
interface IFlyoutView
interface IView
interface IElement
interface ITransform
interface IShellController
interface IPageController
interface IVisualElementController
interface IElementController
interface IPageContainer<Page>
Public Class Shell
Inherits Page
Implements IFlyoutView, IPageContainer(Of Page), IShellController
- Inheritance
- Attributes
- Implements
Constructors
Shell() |
Creates a new Shell element with default values. |
Fields
Properties
AnchorX |
Gets or sets the X component of the center point for any transform, 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, 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 | (Inherited from VisualElement) |
BackgroundColor |
Gets or sets the color which will fill the background of a VisualElement. This is a bindable property. (Inherited from VisualElement) |
BackgroundImageSource | (Inherited from Page) |
Batched |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from VisualElement) |
Behaviors |
Gets the list of Behaviors associated to this element. This is a bindable property. (Inherited from VisualElement) |
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) |
Bounds |
Gets the bounds of the element. (Inherited from VisualElement) |
class | (Inherited from NavigableElement) |
ClassId |
Gets or sets a value used to identify a collection of semantically similar elements. (Inherited from Element) |
Clip | (Inherited from VisualElement) |
ContainerArea |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Page) |
Current |
Static property providing access to the current Shell. |
CurrentItem |
The currently selected ShellItem or FlyoutItem. |
CurrentPage | |
CurrentState |
The current navigation state of the Shell. |
DesiredSize | (Inherited from VisualElement) |
DisableLayout |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from VisualElement) |
Dispatcher | (Inherited from BindableObject) |
EffectControlProvider |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
Effects |
A list of the effects that are applied to this item. (Inherited from Element) |
FlowDirection |
Gets or sets the layout flow direction. (Inherited from VisualElement) |
FlyoutBackdrop | |
FlyoutBackground | |
FlyoutBackgroundColor |
Gets or sets the background color of the Shell Flyout. |
FlyoutBackgroundImage | |
FlyoutBackgroundImageAspect | |
FlyoutBehavior |
Setting the FlyoutBehavior property to Disabled hides the flyout, which is useful when you only have one ShellItem. The other valid FlyoutBehavior values are Flyout (default), and Locked. |
FlyoutContent | |
FlyoutContentTemplate | |
FlyoutFooter | |
FlyoutFooterTemplate | |
FlyoutHeader |
The flyout header is the content that optionally appears at the top of the flyout, with its appearance being defined by a View that can be set through the FlyoutHeader property value. |
FlyoutHeaderBehavior |
Setting the FlyoutHeaderBehavior to CollapseOnScroll collapses the flyout as scrolling occurs. The other valid FlyoutHeaderBehavior values are Default, Fixed, and Scroll (scroll with the menu items). |
FlyoutHeaderTemplate |
The flyout header appearance can be defined by setting the FlyoutHeaderTemplate property to a DataTemplate. |
FlyoutHeight | |
FlyoutIcon |
Gets or sets the icon that, when pressed, opens the Shell Flyout. |
FlyoutIsPresented |
Gets or sets the visible status of the Shell Flyout. |
FlyoutItems | |
FlyoutVerticalScrollMode | |
FlyoutWidth | |
Frame | (Inherited from VisualElement) |
Handler | (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. (Inherited from VisualElement) |
IconImageSource | (Inherited from Page) |
Id |
Gets a value that can be used to uniquely identify an element through the run of an application. (Inherited from Element) |
IgnoresContainerArea |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Page) |
InputTransparent |
Gets or sets a value indicating whether this element should be involved in the user interaction cycle. This is a bindable property. (Inherited from VisualElement) |
InternalChildren |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Page) |
IsBusy |
Marks the Page as busy. This will cause the platform specific global activity indicator to show a busy state. (Inherited from Page) |
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) |
IsInPlatformLayout | (Inherited from VisualElement) |
IsLoaded |
Indicates if a VisualElement is connected to the main object tree. (Inherited from VisualElement) |
IsPlatformEnabled |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from VisualElement) |
IsPlatformStateConsistent | (Inherited from VisualElement) |
IsVisible |
Gets or sets a value that determines whether this elements should be part of the visual tree or not. This is a bindable property. (Inherited from VisualElement) |
Items | |
ItemTemplate |
Gets or sets DataTemplate applied to each of the Items. |
LogicalChildren |
Obsolete.
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
MaximumHeightRequest | (Inherited from VisualElement) |
MaximumWidthRequest | (Inherited from VisualElement) |
MenuBarItems | (Inherited from Page) |
MenuItemTemplate |
Gets or sets the DataTemplate applied to MenuItem objects in the MenuItems collection. |
MinimumHeightRequest |
Gets or sets a value which overrides the minimum height the element will request during layout. (Inherited from VisualElement) |
MinimumWidthRequest |
Gets or sets a value which overrides the minimum width the element will request during layout. (Inherited from VisualElement) |
Navigation | (Inherited from NavigableElement) |
NavigationProxy | (Inherited from NavigableElement) |
Opacity |
Gets or sets the opacity value applied to the element when it is rendered. This is a bindable property. (Inherited from VisualElement) |
Padding |
The space between the content of the Page and it's border. (Inherited from Page) |
Parent |
Gets or sets the parent element of the element. (Inherited from Element) |
RealParent |
For internal use by the Microsoft.Maui.Controls platform. (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. (Inherited from VisualElement) |
RotationX |
Gets or sets the rotation (in degrees) about the X-axis (perspective rotation) when the element is rendered. (Inherited from VisualElement) |
RotationY |
Gets or sets the rotation (in degrees) about the Y-axis (perspective rotation) when the element is rendered. (Inherited from VisualElement) |
Scale |
Gets or sets the scale factor applied to the element. (Inherited from VisualElement) |
ScaleX |
Gets or sets a scale value to apply to the X direction. (Inherited from VisualElement) |
ScaleY |
Gets or sets a scale value to apply to the Y direction. (Inherited from VisualElement) |
Shadow | (Inherited from VisualElement) |
Style | (Inherited from NavigableElement) |
StyleClass | (Inherited from NavigableElement) |
StyleId |
Gets or sets a user defined value to uniquely identify the element. (Inherited from Element) |
Title |
The Page's title. (Inherited from Page) |
ToolbarItems |
A set of ToolbarItems, implemented in a platform-specific manner. (Inherited from Page) |
TranslationX |
Gets or sets the X translation delta of the element. (Inherited from VisualElement) |
TranslationY |
Gets or sets the Y translation delta of the element. (Inherited from VisualElement) |
Triggers |
Gets the list of Trigger associated to this element. This is a bindable property. (Inherited from VisualElement) |
Visual | (Inherited from VisualElement) |
Width |
Gets the current rendered 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. (Inherited from VisualElement) |
Window | (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) |
ZIndex | (Inherited from VisualElement) |
Methods
Events
Appearing | (Inherited from Page) |
BatchCommitted | (Inherited from VisualElement) |
BindingContextChanged | (Inherited from BindableObject) |
ChildAdded | (Inherited from Element) |
ChildRemoved | (Inherited from Element) |
ChildrenReordered | (Inherited from VisualElement) |
DescendantAdded | (Inherited from Element) |
DescendantRemoved | (Inherited from Element) |
Disappearing | (Inherited from Page) |
FocusChangeRequested | (Inherited from VisualElement) |
Focused | (Inherited from VisualElement) |
HandlerChanged | (Inherited from Element) |
HandlerChanging | (Inherited from Element) |
LayoutChanged | (Inherited from Page) |
Loaded |
Occurs when a VisualElement has been constructed and added to the object tree. This event may occur before the VisualElement has been measured so should not be relied on for size information. (Inherited from VisualElement) |
MeasureInvalidated | (Inherited from VisualElement) |
Navigated | |
NavigatedFrom | (Inherited from Page) |
NavigatedTo | (Inherited from Page) |
Navigating | |
NavigatingFrom | (Inherited from Page) |
ParentChanged | (Inherited from Element) |
ParentChanging | (Inherited from Element) |
PropertyChanged | (Inherited from BindableObject) |
PropertyChanging | (Inherited from BindableObject) |
SizeChanged | (Inherited from VisualElement) |
Unfocused | (Inherited from VisualElement) |
Unloaded |
Occurs when this VisualElement is no longer connected to the main object tree. (Inherited from VisualElement) |
Explicit Interface Implementations
Extension Methods
AbortAnimation(IAnimatable, String) |
Stops the animation. |
Animate(IAnimatable, String, Animation, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>) |
Sets the specified parameters and starts the animation. |
Animate(IAnimatable, String, Action<Double>, Double, Double, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>) |
Sets the specified parameters and starts the animation. |
Animate(IAnimatable, String, Action<Double>, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>) |
Sets the specified parameters and starts the animation. |
Animate<T>(IAnimatable, String, Func<Double,T>, Action<T>, UInt32, UInt32, Easing, Action<T,Boolean>, Func<Boolean>, IAnimationManager) |
Sets the specified parameters and starts the animation. |
AnimateKinetic(IAnimatable, String, Func<Double,Double,Boolean>, Double, Double, Action, IAnimationManager) |
Sets the specified parameters and starts the kinetic animation. |
AnimationIsRunning(IAnimatable, String) |
Returns a Boolean value that indicates whether or not the animation that is specified by |
Batch(IAnimatable) | |
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. |
AncestorToRoot(Page) |
For internal use by the Microsoft.Maui.Controls platform. |
FindByName<T>(Element, String) | |
CancelAnimations(VisualElement) |
Aborts all animations (e.g. |
FadeTo(VisualElement, Double, UInt32, Easing) |
Returns a task that performs the fade that is described by the |
LayoutTo(VisualElement, Rect, UInt32, Easing) |
view
to the rectangle that is specified by the bounds parameter. |
RelRotateTo(VisualElement, Double, UInt32, Easing) |
Rotates the VisualElement that is specified by |
RelScaleTo(VisualElement, Double, UInt32, Easing) |
Returns a task that scales the VisualElement that is specified by |
RotateTo(VisualElement, Double, UInt32, Easing) |
Returns a task that rotates the VisualElement that is specified by |
RotateXTo(VisualElement, Double, UInt32, Easing) |
Returns a task that skews the X axis of the the VisualElement that is specified by |
RotateYTo(VisualElement, Double, UInt32, Easing) |
Returns a task that skews the Y axis of the the VisualElement that is specified by |
ScaleTo(VisualElement, Double, UInt32, Easing) |
Returns a task that scales the VisualElement that is specified by |
ScaleXTo(VisualElement, Double, UInt32, Easing) |
Returns a task that scales the X axis of the the VisualElement that is specified by |
ScaleYTo(VisualElement, Double, UInt32, Easing) |
Returns a task that scales the Y axis of the the VisualElement that is specified by |
TranslateTo(VisualElement, Double, Double, UInt32, Easing) |
Animates an elements TranslationX and TranslationY properties from their current values to the new values. This ensures that the input layout is in the same position as the visual layout. |
HasVisualStateGroups(VisualElement) |
Returns |
CheckHandlers(IView) | |
GetEffectiveFlowDirection(IView) | |
ComputeDesiredSize(IView, Double, Double) | |
ComputeFrame(IView, Rect) | |
ShouldArrangeLeftToRight(IView) | |
ToHandler(IElement, IMauiContext) | |
ToPlatform(IElement, IMauiContext) | |
ToHandler(IView, IMauiContext) | |
SetSemanticFocus(IView) | |
CaptureAsync(IView) | |
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) |
Gets list of a Visual Tree Elements children based off of a given x, y point. |
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. |