Back to all docs
API Reference / Telerik.Maui.Controls / RadToolbar

Class
RadToolbar

The RadToolbar is a flexible control for implementation of tool and button strips, needed in most desktop and mobile applications. The individual items of the control are described as a collection of ToolbarItems. The rich collection of ToolbarItems allows to customize every tool or button on the RadToolbar independently according to the specific needs of the application. The control supports horizontal and vertical orientation, overflow menu, panning and scrolling, multi-level navigation and multi-line layout.

Definition

Namespace:Telerik.Maui.Controls

Assembly:Telerik.Maui.Controls.dll

Syntax:
cs-api-definition
public class RadToolbar : ToolbarContentView, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout, IVisualTreeElement

Inheritance: objectRadContentViewRadCompositeContentViewRadBorderContentViewToolbarContentViewRadToolbar

Derived Classes: PdfViewerSelectionMenuToolbarRadPdfViewerToolbarRadImageEditorToolbarRadRichTextEditorToolbar

Implements: IContentViewICrossPlatformLayoutIElementIPaddingIRadContentViewITransformIViewIVisualTreeElement

Inherited Members RadBorderContentView.BackgroundColorPropertyRadBorderContentView.BackgroundPropertyRadBorderContentView.BorderColorPropertyRadBorderContentView.BorderBrushPropertyRadBorderContentView.BorderThicknessPropertyRadBorderContentView.CornerRadiusPropertyRadBorderContentView.ContentPaddingPropertyRadBorderContentView.BackgroundColorRadBorderContentView.BackgroundRadBorderContentView.BorderColorRadBorderContentView.BorderBrushRadBorderContentView.BorderThicknessRadBorderContentView.CornerRadiusRadBorderContentView.ContentPaddingRadCompositeContentView.StylePropertyRadCompositeContentView.ControlTemplatePropertyRadCompositeContentView.OnApplyTemplate()RadCompositeContentView.OnBindingContextChanged()RadCompositeContentView.StyleRadCompositeContentView.ControlTemplateRadContentView.ActualStyleClassPropertyRadContentView.OnChildAdded(Element)RadContentView.OnChildRemoved(Element, int)

Constructors

RadToolbar()

Initializes a new instance of the RadToolbar class.

Declaration

cs-api-definition
public RadToolbar()

Fields

AreScrollButtonsVisibleProperty

Identifies the AreScrollButtonsVisible property.

Declaration

cs-api-definition
public static readonly BindableProperty AreScrollButtonsVisibleProperty

Field Value

BindableProperty

BackNavigationButtonStyleProperty

Identifies the BackNavigationButtonStyle property.

Declaration

cs-api-definition
public static readonly BindableProperty BackNavigationButtonStyleProperty

Field Value

BindableProperty

BackNavigationButtonTemplateProperty

Identifies the BackNavigationButtonTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty BackNavigationButtonTemplateProperty

Field Value

BindableProperty

BackNavigationButtonVisibilityProperty

Identifies the BackNavigationButtonVisibility property.

Declaration

cs-api-definition
public static readonly BindableProperty BackNavigationButtonVisibilityProperty

Field Value

BindableProperty

IsBackNavigationButtonVisibleProperty

Identifies the IsBackNavigationButtonVisible property.

Declaration

cs-api-definition
public static readonly BindableProperty IsBackNavigationButtonVisibleProperty

Field Value

BindableProperty

IsOverflowMenuButtonVisibleProperty

Identifies the IsOverflowMenuButtonVisible property.

Declaration

cs-api-definition
public static readonly BindableProperty IsOverflowMenuButtonVisibleProperty

Field Value

BindableProperty

ItemSpacingProperty

Identifies the ItemSpacing property.

Declaration

cs-api-definition
public static readonly BindableProperty ItemSpacingProperty

Field Value

BindableProperty

LineSpacingProperty

Identifies the LineSpacing property.

Declaration

cs-api-definition
public static readonly BindableProperty LineSpacingProperty

Field Value

BindableProperty

OptionsPanelProperty

Identifies the OptionsPanel property.

Declaration

cs-api-definition
public static readonly BindableProperty OptionsPanelProperty

Field Value

BindableProperty

OrientationProperty

Identifies the Orientation property.

Declaration

cs-api-definition
public static readonly BindableProperty OrientationProperty

Field Value

BindableProperty

OverflowMenuButtonStyleProperty

Identifies the OverflowMenuButtonStyle property.

Declaration

cs-api-definition
public static readonly BindableProperty OverflowMenuButtonStyleProperty

Field Value

BindableProperty

OverflowMenuButtonTemplateProperty

Identifies the OverflowMenuButtonTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty OverflowMenuButtonTemplateProperty

Field Value

BindableProperty

OverflowMenuButtonVisibilityProperty

Identifies the OverflowMenuButtonVisibility property.

Declaration

cs-api-definition
public static readonly BindableProperty OverflowMenuButtonVisibilityProperty

Field Value

BindableProperty

OverflowModeProperty

Identifies the OverflowMode property.

Declaration

cs-api-definition
public static readonly BindableProperty OverflowModeProperty

Field Value

BindableProperty

ScrollBackwardButtonStyleProperty

Identifies the ScrollBackwardButtonStyle property.

Declaration

cs-api-definition
public static readonly BindableProperty ScrollBackwardButtonStyleProperty

Field Value

BindableProperty

ScrollBackwardButtonTemplateProperty

Identifies the ScrollBackwardButtonTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty ScrollBackwardButtonTemplateProperty

Field Value

BindableProperty

ScrollButtonsVisibilityProperty

Identifies the ScrollButtonsVisibility property.

Declaration

cs-api-definition
public static readonly BindableProperty ScrollButtonsVisibilityProperty

Field Value

BindableProperty

ScrollForwardButtonStyleProperty

Identifies the ScrollForwardButtonStyle property.

Declaration

cs-api-definition
public static readonly BindableProperty ScrollForwardButtonStyleProperty

Field Value

BindableProperty

ScrollForwardButtonTemplateProperty

Identifies the ScrollForwardButtonTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty ScrollForwardButtonTemplateProperty

Field Value

BindableProperty

Properties

AreScrollButtonsVisible

Gets a value indicating whether the scroll buttons are currently visible in the toolbar.

Declaration

cs-api-definition
public bool AreScrollButtonsVisible { get; }

Property Value

bool

BackNavigationButtonStyle

Gets or sets the Style applied to the back navigation button in the toolbar. The target type of this style is BackNavigationButtonToolbarItemView.

Declaration

cs-api-definition
public Style BackNavigationButtonStyle { get; set; }

Property Value

Style

BackNavigationButtonTemplate

Gets or sets the ControlTemplate applied to the back navigation button in the toolbar. The target type of this template is BackNavigationButtonToolbarItemView.

Declaration

cs-api-definition
public ControlTemplate BackNavigationButtonTemplate { get; set; }

Property Value

ControlTemplate

BackNavigationButtonVisibility

Gets or sets the visibility mode of the back navigation button in the toolbar. For more information see the ToolbarButtonVisibilityMode type.

Declaration

cs-api-definition
public ToolbarButtonVisibilityMode BackNavigationButtonVisibility { get; set; }

Property Value

ToolbarButtonVisibilityMode

IsBackNavigationButtonVisible

Gets a value indicating whether the back navigation button is currently visible in the toolbar.

Declaration

cs-api-definition
public bool IsBackNavigationButtonVisible { get; }

Property Value

bool

IsOverflowMenuButtonVisible

Gets a value indicating whether the overflow menu button is currently visible in the toolbar.

Declaration

cs-api-definition
public bool IsOverflowMenuButtonVisible { get; }

Property Value

bool

ItemSpacing

Gets or sets the spacing in pixels between the items in the toolbar.

Declaration

cs-api-definition
public double ItemSpacing { get; set; }

Property Value

double

Items

Gets a collection of ToolbarItems associated with the toolbar.

Declaration

cs-api-definition
public IList<ToolbarItem> Items { get; }

Property Value

IList<ToolbarItem>

LineSpacing

Gets or sets the spacing in pixels between the lines of items in the toolbar. This property has effect when the toolbar is in a multi-line wrap overflow mode. For more information see the OverflowMode property.

Declaration

cs-api-definition
public double LineSpacing { get; set; }

Property Value

double

NavigateBackCommand

Gets a command for navigating back to the previous level of the toolbar hierarchy. The previous ToolbarItems stored in the navigation stack from the last invocation of the NavigateCommand are restored in the toolbar.

Declaration

cs-api-definition
public ICommand NavigateBackCommand { get; }

Property Value

ICommand

NavigateCommand

Gets a command for navigating to the next level of the toolbar hierarchy. The command accepts a collection of ToolbarItems as a parameter. The existing ToolbarItems in the toolbar are stored in the navigation stack and then replaced with the provided collection of ToolbarItems.

Declaration

cs-api-definition
public ICommand NavigateCommand { get; }

Property Value

ICommand

OptionsPanel

Gets or sets the options panel associated with this toolbar.

Declaration

cs-api-definition
public RadToolbarOptionsPanel OptionsPanel { get; set; }

Property Value

RadToolbarOptionsPanel

Orientation

Gets or sets the orientation of the toolbar. For more information see the Orientation type.

Declaration

cs-api-definition
public ToolbarOrientation Orientation { get; set; }

Property Value

ToolbarOrientation

OverflowItems

Gets a collection of ToolbarItems in the overflow area of the toolbar.

Declaration

cs-api-definition
public IReadOnlyList<ToolbarItem> OverflowItems { get; }

Property Value

IReadOnlyList<ToolbarItem>

OverflowMenuButtonStyle

Gets or sets the Style applied to the overflow menu button in the toolbar. The target type of this style is OverflowMenuButtonToolbarItemView.

Declaration

cs-api-definition
public Style OverflowMenuButtonStyle { get; set; }

Property Value

Style

OverflowMenuButtonTemplate

Gets or sets the ControlTemplate applied to the overflow menu button in the toolbar. The target type of this template is OverflowMenuButtonToolbarItemView.

Declaration

cs-api-definition
public ControlTemplate OverflowMenuButtonTemplate { get; set; }

Property Value

ControlTemplate

OverflowMenuButtonVisibility

Gets or sets the visibility mode of the overflow menu button in the toolbar. For more information see the ToolbarButtonVisibilityMode type.

Declaration

cs-api-definition
public ToolbarButtonVisibilityMode OverflowMenuButtonVisibility { get; set; }

Property Value

ToolbarButtonVisibilityMode

OverflowMode

Gets or sets the overflow mode of the toolbar, when the items cannot fit in the available space. For more information see the ToolbarOverflowMode type.

Declaration

cs-api-definition
public ToolbarOverflowMode OverflowMode { get; set; }

Property Value

ToolbarOverflowMode

ScrollBackwardButtonStyle

Gets or sets the Style applied to the backward scroll button in the toolbar. The target type of this style is ScrollBackwardButtonToolbarItemView.

Declaration

cs-api-definition
public Style ScrollBackwardButtonStyle { get; set; }

Property Value

Style

ScrollBackwardButtonTemplate

Gets or sets the ControlTemplate applied to the backward scroll button in the toolbar. The target type of this template is ScrollBackwardButtonToolbarItemView.

Declaration

cs-api-definition
public ControlTemplate ScrollBackwardButtonTemplate { get; set; }

Property Value

ControlTemplate

ScrollBackwardCommand

Gets a command for scrolling the contents of the toolbar in backward direction. This command is applicable when the OverflowMode is set to Scroll.

Declaration

cs-api-definition
public ICommand ScrollBackwardCommand { get; }

Property Value

ICommand

ScrollButtonsVisibility

Gets or sets the visibility mode of the scroll buttons in the toolbar. For more information see the ToolbarButtonVisibilityMode type.

Declaration

cs-api-definition
public ToolbarButtonVisibilityMode ScrollButtonsVisibility { get; set; }

Property Value

ToolbarButtonVisibilityMode

ScrollForwardButtonStyle

Gets or sets the Style applied to the forward scroll button in the toolbar. The target type of this style is ScrollForwardButtonToolbarItemView.

Declaration

cs-api-definition
public Style ScrollForwardButtonStyle { get; set; }

Property Value

Style

ScrollForwardButtonTemplate

Gets or sets the ControlTemplate applied to the forward scroll button in the toolbar. The target type of this template is ScrollForwardButtonToolbarItemView.

Declaration

cs-api-definition
public ControlTemplate ScrollForwardButtonTemplate { get; set; }

Property Value

ControlTemplate

ScrollForwardCommand

Gets a command for scrolling the contents of the toolbar in forward direction. This command is applicable when the OverflowMode is set to Scroll.

Declaration

cs-api-definition
public ICommand ScrollForwardCommand { get; }

Property Value

ICommand

StripItems

Gets a collection of ToolbarItems in the strip area of the toolbar.

Declaration

cs-api-definition
public IReadOnlyList<ToolbarItem> StripItems { get; }

Property Value

IReadOnlyList<ToolbarItem>

Methods

ArrangeOverride(Rect)

Declaration

cs-api-definition
protected override Size ArrangeOverride(Rect layoutBounds)

Parameters

layoutBounds

Rect

Returns

Size

MeasureOverride(double, double)

Declaration

cs-api-definition
protected override Size MeasureOverride(double widthConstraint, double heightConstraint)

Parameters

widthConstraint

double

heightConstraint

double

Returns

Size

OnHandlerChanged()

Called when the handler changes.

Declaration

cs-api-definition
protected override void OnHandlerChanged()

Overrides RadContentView.OnHandlerChanged()

OnPropertyChanged(string)

Declaration

cs-api-definition
protected override void OnPropertyChanged(string propertyName = null)

Parameters

propertyName

string

Overrides RadCompositeContentView.OnPropertyChanged(string)

In this article
DefinitionConstructorsRadToolbar()FieldsAreScrollButtonsVisiblePropertyBackNavigationButtonStylePropertyBackNavigationButtonTemplatePropertyBackNavigationButtonVisibilityPropertyIsBackNavigationButtonVisiblePropertyIsOverflowMenuButtonVisiblePropertyItemSpacingPropertyLineSpacingPropertyOptionsPanelPropertyOrientationPropertyOverflowMenuButtonStylePropertyOverflowMenuButtonTemplatePropertyOverflowMenuButtonVisibilityPropertyOverflowModePropertyScrollBackwardButtonStylePropertyScrollBackwardButtonTemplatePropertyScrollButtonsVisibilityPropertyScrollForwardButtonStylePropertyScrollForwardButtonTemplatePropertyPropertiesAreScrollButtonsVisibleBackNavigationButtonStyleBackNavigationButtonTemplateBackNavigationButtonVisibilityIsBackNavigationButtonVisibleIsOverflowMenuButtonVisibleItemSpacingItemsLineSpacingNavigateBackCommandNavigateCommandOptionsPanelOrientationOverflowItemsOverflowMenuButtonStyleOverflowMenuButtonTemplateOverflowMenuButtonVisibilityOverflowModeScrollBackwardButtonStyleScrollBackwardButtonTemplateScrollBackwardCommandScrollButtonsVisibilityScrollForwardButtonStyleScrollForwardButtonTemplateScrollForwardCommandStripItemsMethodsArrangeOverride(Rect)MeasureOverride(double, double)OnHandlerChanged()OnPropertyChanged(string)
Not finding the help you need?
Contact Support