Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
FlyoutItem Class
Definition
- Namespace:
- Microsoft.Maui.Controls
- Assembly:
- Microsoft.Maui.Controls.dll
- Source:
- ShellItem.cs
- Source:
- ShellItem.cs
- Source:
- ShellItem.cs
- Source:
- ShellItem.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.
Represents a flyout menu item in a Shell application.
public ref class FlyoutItem : Microsoft::Maui::Controls::ShellItem
public class FlyoutItem : Microsoft.Maui.Controls.ShellItem
type FlyoutItem = class
inherit ShellItem
Public Class FlyoutItem
Inherits ShellItem
- Inheritance
- Inheritance
Constructors
| Name | Description |
|---|---|
| FlyoutItem() |
Initializes a new instance of the FlyoutItem class. |
Fields
| Name | Description |
|---|---|
| ImageStyle |
The style class for flyout item images. |
| IsVisibleProperty |
Bindable property for attached property |
| LabelStyle |
The style class for flyout item labels. |
| LayoutStyle |
The style class for flyout item layouts. |
| transientNamescope | (Inherited from Element) |
Properties
| Name | Description |
|---|---|
| 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) |
| CurrentItem |
Gets or sets the currently selected ShellSection. This is a bindable property. (Inherited from ShellItem) |
| 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) |
| FlyoutDisplayOptions |
Gets or sets how this item is displayed in the flyout. This is a bindable property. (Inherited from ShellGroupItem) |
| FlyoutIcon |
Gets or sets the icon displayed for this item in the flyout. This is a bindable property. (Inherited from BaseShellItem) |
| FlyoutItemIsVisible |
Gets or sets a value indicating whether this item is visible in the flyout menu. This is a bindable property. (Inherited from BaseShellItem) |
| Handler |
Gets or sets the associated handler for this element. (Inherited from Element) |
| Icon |
Gets or sets the icon displayed for this item in the tab bar. This is a bindable property. (Inherited from BaseShellItem) |
| Id |
Gets a value that can be used to uniquely identify an element throughout the run of your application. (Inherited from Element) |
| IsChecked |
Gets a value indicating whether this item is currently selected. This is a bindable property. (Inherited from BaseShellItem) |
| IsEnabled |
Gets or sets a value indicating whether this item is enabled. This is a bindable property. (Inherited from BaseShellItem) |
| IsVisible |
Gets or sets a value indicating whether this item is visible in the Shell UI. This is a bindable property. (Inherited from BaseShellItem) |
| Items |
Gets the collection of ShellSection items. This is a bindable property. (Inherited from ShellItem) |
| 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 |
Gets or sets the route used for URI-based Shell navigation. (Inherited from BaseShellItem) |
| 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 |
Gets or sets the title displayed in the UI for this item. This is a bindable property. (Inherited from BaseShellItem) |
| Window | (Inherited from BaseShellItem) |
Methods
| Name | Description |
|---|---|
| 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) |
| GetIsVisible(BindableObject) |
Gets the value of the attached |
| 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) |
| InvalidateStyle() |
Forces unapply and reapply of the current merged style. This method is intended for infrastructure use (e.g., Hot Reload) and should not be used in application code. (Inherited from StyleableElement) |
| IsSet(BindableProperty) |
Determines whether or not a bindable property exists and has a value set. (Inherited from BindableObject) |
| On<T>() |
Returns the platform-specific instance of this |
| 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) | (Inherited from ShellItem) |
| OnChildRemoved(Element, Int32) | (Inherited from ShellItem) |
| OnDisappearing() | (Inherited from BaseShellItem) |
| 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() | (Inherited from ShellItem) |
| OnPropertyChanged(String) | (Inherited from BaseShellItem) |
| 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) |
| SetIsVisible(BindableObject, Boolean) |
Sets the value of the attached |
| 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
| Name | Description |
|---|---|
| Appearing | (Inherited from BaseShellItem) |
| 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 | (Inherited from BaseShellItem) |
| 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
| Name | Description |
|---|---|
| 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 |
| 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) |
| IShellItemController.GetItems() | (Inherited from ShellItem) |
| IShellItemController.ItemsCollectionChanged | (Inherited from ShellItem) |
| IShellItemController.ProposeSection(ShellSection, Boolean) | (Inherited from ShellItem) |
| IShellItemController.ShowTabs | (Inherited from ShellItem) |
| 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
Applies to
Feedback
Was this page helpful?
