ToolbarButton Class

A button within a DXToolbar control.

Namespace : DevExpress.Maui.Controls

Assembly : DevExpress.Maui.Controls.dll

NuGet Package : DevExpress.Maui.Controls

Declaration

[DXLicenseMAUI]
public class ToolbarButton :
    ToolbarContentItemBase

Remarks

Create a ToolbarButton class instance to add a regular button to a DXToolbar control.

Specify the ToolbarContentItemBase.Content inherited property to display a text label or object next to the button icon.

The following code sample displays a ToolbarButton on the main page of a DXToolbar control:

• XAML

<ContentPage ...
    xmlns:dxc="clr-namespace:DevExpress.Maui.Controls;assembly=DevExpress.Maui.Controls">
    <Grid>
        <dxc:DXToolbar>
            <!-- ... -->
            <dxc:ToolbarButton Icon="goto" Content="Go To Page" />
        </dxc:DXToolbar>
    </Grid>
</ContentPage>

Handle Taps

Use the Clicked event to handle a ToolbarButton tap.

You can also use the Command property to specify a command that is invoked when a user taps a ToolbarButton. You can define the CommandParameter property to specify a command’s parameter.

• MainPage.xaml

<ContentPage ...
    xmlns:dxc="clr-namespace:DevExpress.Maui.Controls;assembly=DevExpress.Maui.Controls"
    xmlns:local="clr-namespace:ToolbarApplication">
    <ContentPage.BindingContext>
        <local:MainViewModel/>
    </ContentPage.BindingContext>
    <Grid>
        <dxc:DXToolbar>
            <!-- ... -->
            <dxc:ToolbarButton x:Name="gotobutton" Content="Go To Page" Icon="goto" Command="{Binding TapButtonCommand}" 
                                  CommandParameter="{Binding ButtonType, Source={x:Reference gotobutton}}" />
        </dxc:DXToolbar>
    </Grid>
</ContentPage>

• MainViewModel.cs

public class MainViewModel: INotifyPropertyChanged {
    public ICommand TapButtonCommand { get; set; }
    public MainViewModel() {
        this.TapButtonCommand = new Command<DXButtonType>(OnButtonTap);
    }
    private async void OnButtonTap(DXButtonType buttontype) {
        await Application.Current.MainPage.DisplayAlert("The item is tapped", "The button type is "+buttontype, "Ok");
    }
    // ...
}

You can customize button appearance in the pressed state. Use Pressed*Color properties to specify colors for various button elements (text, background, icon, and more).

Button Types

The ToolbarButton class includes the ButtonType property. The list below contains the available button types and corresponding button appearances in different states:

ToolButton (default)

Accent

Filled

Outlined

Text

Button Availability

Use the IsEnabled property to specify whether the ToolbarButton is enabled. You can customize button appearance in the disabled state. Use Disabled*Color properties to change the colors of button elements (text, background, icon, and more).

Handle Loading

You can use the following inherited member to handle the ToolbarButton loading:

Customize Appearance

You can use the following properties to customize common ToolbarButton appearance settings:

Size and Alignment

You can use the following properties to customize common ToolbarButton size and alignment settings:

Background Color

You can use the following properties to change the background color for a ToolbarButton :

Border

You can use the following properties to customize the border for a ToolbarButton :

Icon

You can use the following properties to display and customize an icon within a ToolbarButton :

Text and Font Settings

You can use the following properties to customize font settings for a ToolbarButton :

Customize Animation

The ToolbarButton displays the animation when you tap it. You can use the following properties to customize this animation:

Implements

INotifyPropertyChanged

IElementController

Inheritance

Show 11 items

System.Object BindableObject Element DevExpress.Maui.Core.Internal.DXElementBaseCore DXElementBase ToolbarElementBase ToolbarItemBase ToolbarContentItemBase ToolbarButton ToolbarNavigationButton

ToolbarToggleButton

Extension Methods

Yield<ToolbarButton>()

YieldIfNotNull<ToolbarButton>()

See Also

ToolbarButton Members

Items

DevExpress.Maui.Controls Namespace