ToolbarNavigationButton Class

A toolbar button that navigates you to the specified ToolbarPage.

Namespace : DevExpress.Maui.Controls

Assembly : DevExpress.Maui.Controls.dll

NuGet Package : DevExpress.Maui.Controls

Declaration

[DXLicenseMAUI]
public class ToolbarNavigationButton :
    ToolbarButton

Remarks

The ToolbarNavigationButton is a ToolbarButton descendant that navigates you to a defined ToolbarPage on tap.

Add ToolbarNavigationButton to DXToolbar

The following code sample displays a ToolbarNavigationButton that navigates you to the FontSettings ToolbarPage on tap:

• XAML

<ContentPage ...
    xmlns:dxc="clr-namespace:DevExpress.Maui.Controls;assembly=DevExpress.Maui.Controls">
    <Grid>
        <dxc:DXToolbar>
            <dxc:ToolbarNavigationButton PageName="FontSettings" Icon="font" Content="Open TOC"/>
            <dxc:ToolbarPage Name="FontSettings">
                <!-- ... -->
            </dxc:ToolbarPage>
        </dxc:DXToolbar>
    </Grid>
</ContentPage>

Handle Taps

Use the ToolbarButton.Clicked inherited event to handle a ToolbarNavigationButton tap.

You can also use the ToolbarButton.Command inherited property to specify a command that is invoked when a user taps a ToolbarNavigationButton. You can define the ToolbarButton.CommandParameter inherited 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:ToolbarNavigationButton x:Name="fontsettingsbutton" PageName="FontSettings" Icon="font" Command="{Binding TapButtonCommand}" 
                                            CommandParameter="{Binding ButtonType, Source={x:Reference fontsettingsbutton}}" Content="Open TOC"/>
        </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 pressed state. Use Pressed*Color properties to specify colors for various button elements (text, background, icon, and more).

Available 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 ToolbarNavigationButton is enabled. You can customize button appearance in 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 ToolbarNavigationButton loading:

Customize Appearance

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

Size and Alignment

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

Background Color

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

Border

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

Icon

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

Text and Font Settings

You can use the following properties to display and customize font settings for a ToolbarNavigationButton :

Customize Animation

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

Implements

INotifyPropertyChanged

IElementController

Inheritance

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

Extension Methods

Yield<ToolbarNavigationButton>()

YieldIfNotNull<ToolbarNavigationButton>()

See Also

ToolbarNavigationButton Members

Items

DevExpress.Maui.Controls Namespace