ToolbarButton Members
A button within a DXToolbar control.Constructors
| Name | Description |
|---|---|
| ToolbarButton() | Initializes a new instance of the ToolbarButton class. |
Fields
| Name | Description |
|---|---|
| AnimationDurationProperty static | Identifies the AnimationDuration bindable property. |
| AutomationIdProperty static | Bindable property for AutomationId. Inherited from Element. |
| BackgroundColorProperty static | Identifies the BackgroundColor bindable property. Inherited from ToolbarContentItemBase. |
| BackgroundProperty static | Identifies the Background bindable property. Inherited from ToolbarContentItemBase. |
| BindingContextProperty static | Bindable property for BindingContext. Inherited from BindableObject. |
| BorderColorProperty static | Identifies the BorderColor bindable property. Inherited from ToolbarContentItemBase. |
| BorderThicknessProperty static | Identifies the BorderThickness bindable property. Inherited from ToolbarContentItemBase. |
| ButtonTypeProperty static | Identifies the ButtonType bindable property. |
| ClassIdProperty static | Bindable property for ClassId. Inherited from Element. |
| CommandParameterProperty static | Identifies the CommandParameter bindable property. |
| CommandProperty static | Identifies the Command bindable property. |
| ContentProperty static | Identifies the Content bindable property. Inherited from ToolbarContentItemBase. |
| ContentTemplateProperty static | Identifies the ContentTemplate bindable property. Inherited from ToolbarContentItemBase. |
| ContentTemplateSelectorProperty static | Identifies the ContentTemplateSelector bindable property. Inherited from ToolbarContentItemBase. |
| CornerRadiusProperty static | Identifies the CornerRadius bindable property. Inherited from ToolbarContentItemBase. |
| DisabledBackgroundColorProperty static | Identifies the DisabledBackgroundColor bindable property. |
| DisabledBorderColorProperty static | Identifies the DisabledBorderColor bindable property. |
| DisabledIconColorProperty static | Identifies the DisabledIconColor bindable property. |
| DisabledTextColorProperty static | Identifies the DisabledTextColor bindable property. |
| FontAttributesProperty static | Identifies the FontAttributes bindable property. Inherited from ToolbarContentItemBase. |
| FontAutoScalingEnabledProperty static | Identifies the FontAutoScalingEnabled bindable property. Inherited from ToolbarContentItemBase. |
| FontFamilyProperty static | Identifies the FontFamily bindable property. Inherited from ToolbarContentItemBase. |
| FontSizeProperty static | Identifies the FontSize bindable property. Inherited from ToolbarContentItemBase. |
| HeightRequestProperty static | Identifies the HeightRequest bindable property. Inherited from ToolbarContentItemBase. |
| HorizontalContentAlignmentProperty static | Identifies the HorizontalContentAlignment bindable property. Inherited from ToolbarContentItemBase. |
| HorizontalOptionsProperty static | Identifies the HorizontalOptions bindable property. Inherited from ToolbarContentItemBase. |
| IconAspectProperty static | Identifies the IconAspect bindable property. Inherited from ToolbarContentItemBase. |
| IconColorizationEnabledProperty static | Identifies the IconColorizationEnabled bindable property. Inherited from ToolbarContentItemBase. |
| IconColorProperty static | Identifies the IconColor bindable property. Inherited from ToolbarContentItemBase. |
| IconHeightProperty static | Identifies the IconHeight bindable property. Inherited from ToolbarContentItemBase. |
| IconIndentProperty static | Identifies the IconIndent bindable property. Inherited from ToolbarContentItemBase. |
| IconPlacementProperty static | Identifies the IconPlacement bindable property. Inherited from ToolbarContentItemBase. |
| IconProperty static | Identifies the Icon bindable property. Inherited from ToolbarContentItemBase. |
| IconWidthProperty static | Identifies the IconWidth bindable property. Inherited from ToolbarContentItemBase. |
| IsClippedToBoundsProperty static | Identifies the IsClippedToBounds bindable property. Inherited from ToolbarContentItemBase. |
| IsEnabledProperty static | Identifies the IsEnabled bindable property. Inherited from ToolbarContentItemBase. |
| IsVisibleProperty static | Identifies the IsVisible bindable property. Inherited from ToolbarItemBase. |
| MarginProperty static | Identifies the Margin bindable property. Inherited from ToolbarContentItemBase. |
| MaximumHeightRequestProperty static | Identifies the MaximumHeightRequest bindable property. Inherited from ToolbarContentItemBase. |
| MaximumWidthRequestProperty static | Identifies the MaximumWidthRequest bindable property. Inherited from ToolbarContentItemBase. |
| MinimumHeightRequestProperty static | Identifies the MinimumHeightRequest bindable property. Inherited from ToolbarContentItemBase. |
| MinimumWidthRequestProperty static | Identifies the MinimumWidthRequest bindable property. Inherited from ToolbarContentItemBase. |
| PaddingProperty static | Identifies the Padding bindable property. Inherited from ToolbarContentItemBase. |
| PlacementProperty static | Identifies the Placement bindable property. Inherited from ToolbarItemBase. |
| PressedBackgroundColorProperty static | Identifies the PressedBackgroundColor bindable property. |
| PressedBorderColorProperty static | Identifies the PressedBorderColor bindable property. |
| PressedIconColorProperty static | Identifies the PressedIconColor bindable property. |
| PressedScaleProperty static | Identifies the PressedScale bindable property. |
| PressedTextColorProperty static | Identifies the PressedTextColor bindable property. |
| ShowContentProperty static | Identifies the ShowContent bindable property. Inherited from ToolbarContentItemBase. |
| ShowIconProperty static | Identifies the ShowIcon bindable property. Inherited from ToolbarContentItemBase. |
| StyleProperty static | Identifies the Style bindable property. Inherited from DXElementBase. |
| TextCharacterSpacingProperty static | Identifies the TextCharacterSpacing bindable property. Inherited from ToolbarContentItemBase. |
| TextColorProperty static | Identifies the TextColor bindable property. Inherited from ToolbarContentItemBase. |
| TextDecorationsProperty static | Identifies the TextDecorations bindable property. Inherited from ToolbarContentItemBase. |
| TextHorizontalAlignmentProperty static | Identifies the TextHorizontalAlignment bindable property. Inherited from ToolbarContentItemBase. |
| TextLineBreakModeProperty static | Identifies the TextLineBreakMode bindable property. Inherited from ToolbarContentItemBase. |
| TextLineHeightProperty static | Identifies the TextLineHeight bindable property. Inherited from ToolbarContentItemBase. |
| TextMaxLinesProperty static | Identifies the TextMaxLines bindable property. Inherited from ToolbarContentItemBase. |
| TextTransformProperty static | Identifies the TextTransform bindable property. Inherited from ToolbarContentItemBase. |
| TextVerticalAlignmentProperty static | Identifies the TextVerticalAlignment bindable property. Inherited from ToolbarContentItemBase. |
| ThemeProperty static | Identifies the Theme bindable property. |
| ThemeSeedColorProperty static | Identifies the ThemeSeedColor bindable property. |
| VerticalContentAlignmentProperty static | Identifies the VerticalContentAlignment bindable property. Inherited from ToolbarContentItemBase. |
| VerticalOptionsProperty static | Identifies the VerticalOptions bindable property. Inherited from ToolbarContentItemBase. |
| ViewStyleProperty static | Identifies the ViewStyle bindable property. Inherited from ToolbarContentItemBase. |
| WidthRequestProperty static | Identifies the WidthRequest bindable property. Inherited from ToolbarContentItemBase. |
Properties
| Name | Description |
|---|---|
| AnimationDuration | Gets or sets the duration of the ToolbarButton‘s scale animation. This is a bindable property. |
| AutomationId | Gets or sets a value that allows the automation framework to find and interact with this element. Inherited from Element. |
| Background | Gets or sets a ToolbarContentItemBase descendant’s background brush. This is a bindable property. Inherited from ToolbarContentItemBase. |
| BackgroundColor | Gets or sets a ToolbarContentItemBase descendant’s background color. This is a bindable property. Inherited from ToolbarContentItemBase. |
| 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. |
| BorderColor | Gets or sets a ToolbarContentItemBase descendant’s border color. This is a bindable property. Inherited from ToolbarContentItemBase. |
| BorderThickness | Gets or sets a ToolbarContentItemBase descendant’s border thickness. This is a bindable property. Inherited from ToolbarContentItemBase. |
| ButtonType | Gets or sets the type of the ToolbarButton. This is a bindable property. |
| ClassId | Gets or sets a value used to identify a collection of semantically similar elements. Inherited from Element. |
| Command | Gets or sets the command executed when a user taps the ToolbarButton. This is a bindable property. |
| CommandParameter | Gets or sets the parameter passed to the Command. This is a bindable property. |
| Content | Gets or sets the custom content of the toolbar button. This is a bindable property. Inherited from ToolbarContentItemBase. |
| ContentTemplate | Gets or sets a template that configures the content‘s appearance. This is a bindable property. Inherited from ToolbarContentItemBase. |
| ContentTemplateSelector | Gets or sets an object that chooses a custom content template based on custom logic. This is a dependency property. Inherited from ToolbarContentItemBase. |
| CornerRadius | Gets or sets a ToolbarContentItemBase descendant’s corner radius. This is a bindable property. Inherited from ToolbarContentItemBase. |
| DisabledBackgroundColor | Gets or sets the background color of the ToolbarButton when it is disabled. This is a bindable property. |
| DisabledBorderColor | Gets or sets the border color of a ToolbarButton when it is disabled. This is a bindable property. |
| DisabledIconColor | Gets or sets the icon color of the ToolbarButton when it is disabled. This is a bindable property. |
| DisabledTextColor | Gets or sets the text color of the ToolbarButton when it is disabled. This is a bindable property. |
| 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. |
| FontAttributes | Gets or sets a ToolbarContentItemBase descendant’s font attributes. This is a bindable property. Inherited from ToolbarContentItemBase. |
| FontAutoScalingEnabled | Gets or sets whether the toolbar item’s text is scaled according to the operating system’s text scale setting. This is a bindable property. Inherited from ToolbarContentItemBase. |
| FontFamily | Gets or sets a ToolbarContentItemBase descendant’s font family. This is a bindable property. Inherited from ToolbarContentItemBase. |
| FontSize | Gets or sets a ToolbarContentItemBase descendant’s font size. This is a bindable property. Inherited from ToolbarContentItemBase. |
| HeightRequest | Gets or sets height of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| HorizontalContentAlignment | Gets or sets the horizontal alignment of a ToolbarContentItemBase descendant’s content. This is a bindable property. Inherited from ToolbarContentItemBase. |
| HorizontalOptions | Gets or sets the horizontal alignment of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| Icon | Gets or sets the icon that is displayed within a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| IconAspect | Gets or sets the aspect of the icon that is displayed within a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| IconColor | Gets or sets the icon color of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| IconColorizationEnabled | Gets or sets whether the toolbar item’s icon should change its colors in pressed and disabled states. This is a bindable property. Inherited from ToolbarContentItemBase. |
| IconHeight | Gets or sets the icon height of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| IconIndent | Gets or sets the icon indent of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| IconPlacement | Gets or sets the icon placement within a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| IconWidth | Gets or sets the icon width of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| Id | Gets a value that can be used to uniquely identify an element throughout the run of your application. Inherited from Element. |
| IsClippedToBounds | Gets or sets whether a ToolbarContentItemBase descendant should clip child controls to its bounds. This is a bindable property. Inherited from ToolbarContentItemBase. |
| IsEnabled | Gets or sets whether a ToolbarContentItemBase descendant is enabled. This is a bindable property. Inherited from ToolbarContentItemBase. |
| IsLoaded | Gets or sets whether a DXElementBase descendant is loaded. Inherited from DXElementBase. |
| IsVisible | Gets or sets whether the toolbar item is visible. This is a bindable property. Inherited from ToolbarItemBase. |
| LogicalChildren | For internal use by the Microsoft.Maui.Controls platform. Inherited from Element. |
| Margin | Gets or sets the margin value of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| MaximumHeightRequest | Gets or sets maximum height of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| MaximumWidthRequest | Gets or sets maximum width of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| MinimumHeightRequest | Gets or sets minimum height of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| MinimumWidthRequest | Gets or sets minimum width of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| Padding | Gets or sets the padding of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| Parent | Gets or sets the parent Element of this element. Inherited from Element. |
| Placement | Gets or sets the position of a ToolbarItemBase descendant within the DXToolbar control. This is a bindable property. Inherited from ToolbarItemBase. |
| PressedBackgroundColor | Gets or sets the background color of the ToolbarButton when it is pressed. This is a bindable property. |
| PressedBorderColor | Gets or sets the border color of the ToolbarButton when it is pressed. This is a bindable property. |
| PressedIconColor | Gets or sets the icon color of the ToolbarButton when it is pressed. This is a bindable property. |
| PressedScale | Gets or sets the toolbar button scale when it is pressed. This is a bindable property. |
| PressedTextColor | Gets or sets the text color of the ToolbarButton when it is pressed. This is a bindable property. |
| RealParent | For internal use by .NET MAUI. Inherited from Element. |
| ShowContent | Gets or sets whether a ToolbarContentItemBase descendant’s content is displayed. This is a bindable property. Inherited from ToolbarContentItemBase. |
| ShowIcon | Gets or sets whether a ToolbarContentItemBase descendant’s icon is displayed. This is a bindable property. Inherited from ToolbarContentItemBase. |
| Style | Gets or sets the style applied to a DXElementBase descendant. This is a bindable property. Inherited from DXElementBase. |
| StyleId | Gets or sets a user defined value to uniquely identify the element. Inherited from Element. |
| TextCharacterSpacing | Gets or sets the spacing between characters of a ToolbarContentItemBase descendant’s text. This is a bindable property. Inherited from ToolbarContentItemBase. |
| TextColor | Gets or sets the text color of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| TextDecorations | Gets or sets text decorations applied to a ToolbarContentItemBase descendant’s text. This is a bindable property. Inherited from ToolbarContentItemBase. |
| TextHorizontalAlignment | Gets or sets the horizontal alignment applied to a ToolbarContentItemBase descendant’s text. This is a bindable property. Inherited from ToolbarContentItemBase. |
| TextLineBreakMode | Gets or sets the line breaking mode for a ToolbarContentItemBase descendant’s text. This is a bindable property. Inherited from ToolbarContentItemBase. |
| TextLineHeight | Gets or sets line height applied to a ToolbarContentItemBase descendant’s text. This is a bindable property. Inherited from ToolbarContentItemBase. |
| TextMaxLines | Gets or sets the maximum number of a ToolbarContentItemBase descendant’s text. This is a bindable property. Inherited from ToolbarContentItemBase. |
| TextTransform | Gets or sets the transformation applied to the text. This is a bindable property. Inherited from ToolbarContentItemBase. |
| TextVerticalAlignment | Gets or sets the vertical alignment applied to a ToolbarContentItemBase descendant’s text. This is a bindable property. Inherited from ToolbarContentItemBase. |
| Theme | Gets or sets the theme applied to the ToolbarButton. This is a bindable property. |
| ThemeSeedColor | Gets or sets the predefined color used to generate colors for ToolbarButton. This is a bindable property. |
| VerticalContentAlignment | Gets or sets the vertical alignment of a ToolbarContentItemBase descendant’s content. This is a bindable property. Inherited from ToolbarContentItemBase. |
| VerticalOptions | Gets or sets the vertical alignment of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
| ViewStyle | Gets or sets the style that is applied to the DXButton that is displayed within the ToolbarButton. This is a bindable property. |
| WidthRequest | Gets or sets width of a ToolbarContentItemBase descendant. This is a bindable property. Inherited from ToolbarContentItemBase. |
Methods
| Name | Description |
|---|---|
| ApplyBindings() protected | Applies all the current bindings to BindingContext. Inherited from BindableObject. |
| 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. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| FindByName(String) | Returns the element that has the specified name. Inherited from Element. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| GetValue(BindableProperty) | Returns the value that is contained in the given bindable property. Inherited from BindableObject. |
| IsSet(BindableProperty) | Determines whether or not a bindable property exists and has a value set. Inherited from BindableObject. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| IElementController.SetValueFromRenderer(BindableProperty, Object) | For internal use by .NET MAUI. Inherited from Element. |
| OnBindingContextChanged() protected | Invoked whenever the binding context of the element changes. Implement this method to add class handling for this event. Inherited from Element. |
| OnChildAdded(Element) protected | Raises the ChildAdded event. Implement this method to add class handling for this event. Inherited from Element. |
| OnChildRemoved(Element, Int32) protected | Raises the ChildRemoved event. Implement this method to add class handling for this event Inherited from Element. |
| OnParentSet() protected |
Raises the (internal) ParentSet event. Implement this method in order to add behavior when the element is added to a parent.
Inherited from Element. |
| OnPropertyChanging(String) protected | Raises the PropertyChanging event. Inherited from BindableObject. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| 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. |
| 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. |
| SetInheritedBindingContext(BindableObject, Object) static | Sets the inherited context to a nested element. Inherited from BindableObject. |
| 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. |
| SetValueCore(BindableProperty, Object, SetValueFlags) | For internal use by the Microsoft.Maui.Controls platform. 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. |
| ToString() | Returns a string that represents the current object. Inherited from Object. |
| UnapplyBindings() protected | Removes all current bindings from the current context. Inherited from BindableObject. |
Events
| Name | Description |
|---|---|
| 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 | Fires when a user taps the toolbar button. |
| 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. |
| Loaded | Fires when the DXElementBase descendant is loaded. Inherited from DXElementBase. |
| PropertyChanged | Occurs when a property value changes. Inherited from BindableObject. |
| PropertyChanging | Occurs when a property value is changing. Inherited from BindableObject. |
| Unloaded | Fires when the DXElementBase descendant is unloaded. Inherited from DXElementBase. |
See Also