FlyoutItem Class

Definition

A ShellItem that has a collection of Tab objects.

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

Constructors

FlyoutItem()

Fields

ImageStyle

StyleClass set on the Image of each Flyout Item. This const is set to "FlyoutItemImageStyle".

IsVisibleProperty
LabelStyle

StyleClass set on the Label of each Flyout Item. This const is set to "FlyoutItemLabelStyle".

LayoutStyle

StyleClass set on the Label of every Flyout Item. This const is set to "FlyoutItemLayoutStyle".

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.

(Inherited from ShellItem)
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)
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)
FlyoutItemIsVisible (Inherited from BaseShellItem)
Handler (Inherited from Element)
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)
IsVisible (Inherited from BaseShellItem)
Items

The collection of ShellSection objects managed by thisShellItem.

(Inherited from ShellItem)
LogicalChildren
Obsolete.

For internal use by the Microsoft.Maui.Controls 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)
RealParent

For internal use by the Microsoft.Maui.Controls 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)
Title

Title to display in the UI.

(Inherited from BaseShellItem)
Window (Inherited from BaseShellItem)

Methods

ApplyBindings() (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)
EffectIsAttached(String)

For internal use by the Microsoft.Maui.Controls platform.

(Inherited from Element)
FindByName(String)

Returns the element that has the specified name.

(Inherited from Element)
GetIsVisible(BindableObject)
GetValue(BindableProperty)

Returns the value that is contained in the BindableProperty.

(Inherited from BindableObject)
IsSet(BindableProperty)

Returns true if the target property exists and has been set.

(Inherited from BindableObject)
On<T>()

Returns the platform-specific instance of this TElement, on which a platform-specific method may be called.

(Inherited from ShellItem)
OnAppearing() (Inherited from BaseShellItem)
OnBindingContextChanged() (Inherited from Element)
OnChildAdded(Element) (Inherited from ShellItem)
OnChildRemoved(Element, Int32) (Inherited from ShellItem)
OnDisappearing() (Inherited from BaseShellItem)
OnHandlerChanged() (Inherited from Element)
OnHandlerChanging(HandlerChangingEventArgs) (Inherited from Element)
OnParentChanged() (Inherited from Element)
OnParentChanging(ParentChangingEventArgs) (Inherited from Element)
OnParentSet() (Inherited from ShellItem)
OnPropertyChanged(String) (Inherited from BaseShellItem)
OnPropertyChanging(String) (Inherited from BindableObject)
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)
SetIsVisible(BindableObject, Boolean)
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 Microsoft.Maui.Controls platform.

(Inherited from BindableObject)
SetValueFromRenderer(BindableProperty, Object)

For internal use by the Microsoft.Maui.Controls platform.

(Inherited from Element)
SetValueFromRenderer(BindablePropertyKey, Object)

For internal use by the Microsoft.Maui.Controls platform.

(Inherited from Element)
UnapplyBindings() (Inherited from BindableObject)

Events

Appearing (Inherited from BaseShellItem)
BindingContextChanged (Inherited from BindableObject)
ChildAdded (Inherited from Element)
ChildRemoved (Inherited from Element)
DescendantAdded (Inherited from Element)
DescendantRemoved (Inherited from Element)
Disappearing (Inherited from BaseShellItem)
HandlerChanged (Inherited from Element)
HandlerChanging (Inherited from Element)
ParentChanged (Inherited from Element)
ParentChanging (Inherited from Element)
PropertyChanged (Inherited from BindableObject)
PropertyChanging (Inherited from BindableObject)

Explicit Interface Implementations

IContextFlyoutElement.ContextFlyout (Inherited from Element)
IDynamicResourceHandler.SetDynamicResource(BindableProperty, String) (Inherited from BindableObject)
IEffectControlProvider.RegisterEffect(Effect) (Inherited from Element)
IElement.Parent (Inherited from Element)
IElementController.Descendants() (Inherited from Element)
IElementController.LogicalChildren (Inherited from Element)
IElementController.SetValueFromRenderer(BindableProperty, Object) (Inherited from Element)
INameScope.RegisterName(String, Object) (Inherited from Element)
INameScope.UnregisterName(String) (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 (Inherited from Element)
IVisualTreeElement.GetVisualChildren() (Inherited from ShellItem)
IVisualTreeElement.GetVisualParent() (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.

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)

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.

Applies to