ToolbarItem 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.
An item in a toolbar or displayed on a Page.
public ref class ToolbarItem : Microsoft::Maui::Controls::MenuItempublic class ToolbarItem : Microsoft.Maui.Controls.MenuItemtype ToolbarItem = class
inherit MenuItemPublic Class ToolbarItem
Inherits MenuItem- Inheritance
Remarks
Any changes made to the properties of the toolbar item after it has been added will be ignored.
Constructors
| ToolbarItem() |
Constructs and initializes a new instance of the ToolbarItem class. |
| ToolbarItem(String, String, Action, ToolbarItemOrder, Int32) |
Constructs and initializes a new instance of the ToolbarItem class. |
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 | (Inherited from MenuItem) |
| ClassId |
Gets or sets a value used to identify a collection of semantically similar elements. (Inherited from Element) |
| Command |
Gets or sets the command that is run when the menu is clicked. (Inherited from MenuItem) |
| CommandParameter |
Gets or sets the parameter that is passed to the command. (Inherited from MenuItem) |
| 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) |
| Handler |
Gets or sets the associated handler for this element. (Inherited from Element) |
| IconImageSource | (Inherited from MenuItem) |
| Id |
Gets a value that can be used to uniquely identify an element throughout the run of your application. (Inherited from Element) |
| IsDestructive |
Gets or sets a value that indicates whether or not the menu item removes its associated UI element. (Inherited from MenuItem) |
| IsEnabled |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from MenuItem) |
| LogicalChildren |
Obsolete.
(Inherited from Element)
|
| Order |
Gets or sets a value that indicates on which of the primary, secondary, or default toolbar surfaces to display this ToolbarItem element. |
| Parent |
Gets or sets the parent Element of this element. (Inherited from Element) |
| Priority |
Gets or sets the priority of this ToolbarItem element. |
| RealParent |
For internal use by .NET MAUI. (Inherited from Element) |
| StyleClass |
Sets the StyleClass of the generated FlyoutItem when used with Shell (Inherited from MenuItem) |
| StyleId |
Gets or sets a user defined value to uniquely identify the element. (Inherited from Element) |
| Text |
The text of the menu item. (Inherited from MenuItem) |
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) |
| 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) |
| OnClicked() | (Inherited from MenuItem) |
| 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) |
| OnPropertyChanged(String) |
Method that is called when a bound property is changed. (Inherited from Element) |
| 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
| 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) |
| Clicked | (Inherited from MenuItem) |
| 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) |
| 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 |
| 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) |
| IImageSourcePart.IsAnimationPlaying | (Inherited from MenuItem) |
| IImageSourcePart.Source | (Inherited from MenuItem) |
| IImageSourcePart.UpdateIsLoading(Boolean) | (Inherited from MenuItem) |
| IMenuElement.Clicked() | (Inherited from MenuItem) |
| IMenuItemController.Activate() | (Inherited from MenuItem) |
| 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) |
| ITextStyle.CharacterSpacing | (Inherited from MenuItem) |
| ITextStyle.Font | (Inherited from MenuItem) |
| ITextStyle.TextColor | (Inherited from MenuItem) |
| 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) |
