ToolbarItem Class

Definition

An item in a toolbar or displayed on a Page.

public class ToolbarItem : Xamarin.Forms.MenuItem
type ToolbarItem = class
    inherit MenuItem
Inheritance

Remarks

Any changes made to the properties of the toolbar item after it has been added will be ignored.

Windows Phone ApplicationBarButtons and MenuItems always display an associated text. Therefore, when developing for Windows Phone, application devs should provide a value for the Text property. Otherwise, the file name of the icon image will be dixplayed as the text of the ToolbarItem. (For example, the user might see "menu.png" in the user interface.)

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 object that contains the properties that will be targeted by the bound properties that belong to this BindableObject.

(Inherited from BindableObject)
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)
EffectControlProvider

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
Effects

A list of the effects that are applied to this item.

(Inherited from Element)
Icon

Gets or sets the icon for the menu item.

(Inherited from MenuItem)
IconImageSource (Inherited from MenuItem)
Id

Gets a value that can be used to uniquely identify an element through the run of an 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 Xamarin.Forms platform.

(Inherited from MenuItem)
IsEnabledPropertyName (Inherited from MenuItem)
LogicalChildren

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
Name

Obsolete. Developers should use the inherited Text property, instead.

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 the element.

(Inherited from Element)
ParentView

Gets the element which is the closest ancestor of this element that is a VisualElement.

(Inherited from Element)
Platform (Inherited from Element)
Priority

Gets or sets the priority of this ToolbarItem element.

RealParent

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
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

ApplyBindings()

Apply the bindings to BindingContext.

(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)
Descendants()

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
EffectIsAttached(String)

For internal use by the Xamarin.Forms platform.

(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 BindableProperty.

(Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty)

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty, BindableProperty)

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
IsSet(BindableProperty)

Returns true if the target property exists and has been 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)

Invoked whenever the ChildAdded event needs to be emitted. Implement this method to add class handling for this event.

(Inherited from Element)
OnChildRemoved(Element)

Invoked whenever the ChildRemoved event needs to be emitted. Implement this method to add class handling for this event.

(Inherited from Element)
OnClicked()

When overridden by an app dev, implements behavior when the menu item is clicked.

(Inherited from MenuItem)
OnParentSet()

Invoked whenever the Parent of an element is set. Implement this method in order to add behavior when the element is added to a parent.

(Inherited from Element)
OnPropertyChanged(String)

Method that is called when a bound property is changed.

(Inherited from Element)
OnPropertyChanging(String)

Call this method from a child class to notify that a change is going to happen on a property.

(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)
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 Xamarin.Forms platform.

(Inherited from BindableObject)
SetValueFromRenderer(BindableProperty, Object)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
SetValueFromRenderer(BindablePropertyKey, Object)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
UnapplyBindings()

Unapplies all previously set bindings.

(Inherited from BindableObject)

Events

Activated

Obsolete. Developers should use the inherited Clicked event, instead.

BindingContextChanged

Raised whenever the BindingContext property changes.

(Inherited from BindableObject)
ChildAdded

Occurs whenever a child element is added to the element.

(Inherited from Element)
ChildRemoved

Occurs whenever a child element is removed from the element.

(Inherited from Element)
Clicked

Event that is raised when the menu item is clicked.

(Inherited from MenuItem)
DescendantAdded

Occurs whenever a child element is added to the elements subtree.

(Inherited from Element)
DescendantRemoved

Occurs whenever a child element is removed from the elements subtree.

(Inherited from Element)
PlatformSet (Inherited from Element)
PropertyChanged

Raised when a property has changed.

(Inherited from BindableObject)
PropertyChanging

Raised when a property is about to change.

(Inherited from BindableObject)

Explicit Interface Implementations

IDynamicResourceHandler.SetDynamicResource(BindableProperty, String)

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
IElementController.SetValueFromRenderer(BindableProperty, Object)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
IMenuItemController.Activate() (Inherited from MenuItem)
INameScope.RegisterName(String, Object)

For internal use only.

(Inherited from Element)

Extension Methods

SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String)

Creates and applies a binding to a property.

SetBinding<TSource>(BindableObject, BindableProperty, Expression<Func<TSource,Object>>, BindingMode, IValueConverter, String)

Creates and applies a binding from an expression.

FindByName<T>(Element, String)

Returns the instance of type T that has name name in the scope that includes element.

Applies to