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.

Inheritance
System.Object
RadContentView
RadCompositeContentView
RadBorderContentView
ToolbarContentView
RadToolbar
PdfViewerSelectionMenuToolbar
RadPdfViewerToolbar
RadImageEditorToolbar
RadRichTextEditorToolbar
Inherited Members
Namespace: Telerik.Maui.Controls
Assembly: Telerik.Maui.Controls.dll

Syntax

public class RadToolbar : ToolbarContentView, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, IToolStripElement, IVisualTreeElement

Constructors

RadToolbar()

Initializes a new instance of the RadToolbar class.

Declaration
public RadToolbar()

Fields

AreScrollButtonsVisibleProperty

Identifies the AreScrollButtonsVisible property.

Declaration
public static readonly BindableProperty AreScrollButtonsVisibleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

BackNavigationButtonStyleProperty

Identifies the BackNavigationButtonStyle property.

Declaration
public static readonly BindableProperty BackNavigationButtonStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

BackNavigationButtonTemplateProperty

Identifies the BackNavigationButtonTemplate property.

Declaration
public static readonly BindableProperty BackNavigationButtonTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

BackNavigationButtonVisibilityProperty

Identifies the BackNavigationButtonVisibility property.

Declaration
public static readonly BindableProperty BackNavigationButtonVisibilityProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

IsBackNavigationButtonVisibleProperty

Identifies the IsBackNavigationButtonVisible property.

Declaration
public static readonly BindableProperty IsBackNavigationButtonVisibleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

IsOverflowMenuButtonVisibleProperty

Identifies the IsOverflowMenuButtonVisible property.

Declaration
public static readonly BindableProperty IsOverflowMenuButtonVisibleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemSpacingProperty

Identifies the ItemSpacing property.

Declaration
public static readonly BindableProperty ItemSpacingProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

LineSpacingProperty

Identifies the LineSpacing property.

Declaration
public static readonly BindableProperty LineSpacingProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

OptionsPanelProperty

Identifies the OptionsPanel property.

Declaration
public static readonly BindableProperty OptionsPanelProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

OrientationProperty

Identifies the Orientation property.

Declaration
public static readonly BindableProperty OrientationProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

OverflowMenuButtonStyleProperty

Identifies the OverflowMenuButtonStyle property.

Declaration
public static readonly BindableProperty OverflowMenuButtonStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

OverflowMenuButtonTemplateProperty

Identifies the OverflowMenuButtonTemplate property.

Declaration
public static readonly BindableProperty OverflowMenuButtonTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

OverflowMenuButtonVisibilityProperty

Identifies the OverflowMenuButtonVisibility property.

Declaration
public static readonly BindableProperty OverflowMenuButtonVisibilityProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

OverflowModeProperty

Identifies the OverflowMode property.

Declaration
public static readonly BindableProperty OverflowModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ScrollBackwardButtonStyleProperty

Identifies the ScrollBackwardButtonStyle property.

Declaration
public static readonly BindableProperty ScrollBackwardButtonStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ScrollBackwardButtonTemplateProperty

Identifies the ScrollBackwardButtonTemplate property.

Declaration
public static readonly BindableProperty ScrollBackwardButtonTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ScrollButtonsVisibilityProperty

Identifies the ScrollButtonsVisibility property.

Declaration
public static readonly BindableProperty ScrollButtonsVisibilityProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ScrollForwardButtonStyleProperty

Identifies the ScrollForwardButtonStyle property.

Declaration
public static readonly BindableProperty ScrollForwardButtonStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ScrollForwardButtonTemplateProperty

Identifies the ScrollForwardButtonTemplate property.

Declaration
public static readonly BindableProperty ScrollForwardButtonTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

Properties

AreScrollButtonsVisible

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

Declaration
public bool AreScrollButtonsVisible { get; }
Property Value
System.Boolean

BackNavigationButtonStyle

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

Declaration
public Style BackNavigationButtonStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

BackNavigationButtonTemplate

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

Declaration
public ControlTemplate BackNavigationButtonTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.ControlTemplate

BackNavigationButtonVisibility

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

Declaration
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
public bool IsBackNavigationButtonVisible { get; }
Property Value
System.Boolean

IsOverflowMenuButtonVisible

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

Declaration
public bool IsOverflowMenuButtonVisible { get; }
Property Value
System.Boolean

Items

Gets a collection of ToolbarItems associated with the toolbar.

Declaration
public IList<ToolbarItem> Items { get; }
Property Value
System.Collections.Generic.IList<ToolbarItem>

ItemSpacing

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

Declaration
public double ItemSpacing { get; set; }
Property Value
System.Double

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
public double LineSpacing { get; set; }
Property Value
System.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
public ICommand NavigateBackCommand { get; }
Property Value
System.Windows.Input.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
public ICommand NavigateCommand { get; }
Property Value
System.Windows.Input.ICommand

OptionsPanel

Gets or sets the options panel associated with this toolbar.

Declaration
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
public ToolbarOrientation Orientation { get; set; }
Property Value
ToolbarOrientation

OverflowItems

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

Declaration
public IReadOnlyList<ToolbarItem> OverflowItems { get; }
Property Value
System.Collections.Generic.IReadOnlyList<ToolbarItem>

OverflowMenuButtonStyle

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

Declaration
public Style OverflowMenuButtonStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

OverflowMenuButtonTemplate

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

Declaration
public ControlTemplate OverflowMenuButtonTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.ControlTemplate

OverflowMenuButtonVisibility

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

Declaration
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
public ToolbarOverflowMode OverflowMode { get; set; }
Property Value
ToolbarOverflowMode

ScrollBackwardButtonStyle

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

Declaration
public Style ScrollBackwardButtonStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

ScrollBackwardButtonTemplate

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

Declaration
public ControlTemplate ScrollBackwardButtonTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.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
public ICommand ScrollBackwardCommand { get; }
Property Value
System.Windows.Input.ICommand

ScrollButtonsVisibility

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

Declaration
public ToolbarButtonVisibilityMode ScrollButtonsVisibility { get; set; }
Property Value
ToolbarButtonVisibilityMode

ScrollForwardButtonStyle

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

Declaration
public Style ScrollForwardButtonStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

ScrollForwardButtonTemplate

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

Declaration
public ControlTemplate ScrollForwardButtonTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.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
public ICommand ScrollForwardCommand { get; }
Property Value
System.Windows.Input.ICommand

StripItems

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

Declaration
public IReadOnlyList<ToolbarItem> StripItems { get; }
Property Value
System.Collections.Generic.IReadOnlyList<ToolbarItem>

Methods

ArrangeOverride(Rect)

Declaration
protected override Size ArrangeOverride(Rect layoutBounds)
Parameters
Microsoft.Maui.Graphics.Rect layoutBounds

Returns
Microsoft.Maui.Graphics.Size

MeasureOverride(Double, Double)

Declaration
protected override Size MeasureOverride(double widthConstraint, double heightConstraint)
Parameters
System.Double widthConstraint

System.Double heightConstraint

Returns
Microsoft.Maui.Graphics.Size

OnHandlerChanged()

Declaration
protected override void OnHandlerChanged()
Overrides

OnPropertyChanged(String)

Declaration
protected override void OnPropertyChanged(string propertyName = null)
Parameters
System.String propertyName

Overrides

Extension Methods