New to Telerik UI for Blazor? Start a free 30-day trial

TelerikToolBar

Class

A responsive toolbar that hosts buttons, toggle buttons, templates, and separators with overflow and optional scrolling. Define items in ChildContent; configure size/fill via Size and FillMode; set overflow behavior with ToolBarOverflowMode through OverflowMode (Menu/Section/Scroll/None). For scrollable toolbars, control buttons with ScrollButtonsVisibility and ScrollButtonsPosition. Accessibility attributes: AriaLabel, AriaControls, and roving TabIndex. Children: ToolBarButtonGroup, ToolBarButton, ToolBarToggleButton, ToolBarSpacer, ToolBarSeparator.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

public class TelerikToolBar : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikToolBar

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.Dispose()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeVoidAsyncWithoutAwait(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnParametersSetAsync()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)ComponentBase.SetParametersAsync(ParameterView)...

Constructors

TelerikToolBar()

public TelerikToolBar()

Properties

AriaControls

string

[Accessibility] Defines the aria-controls attribute of the toolbar.

[Parameter]
public string AriaControls { get; set; }

AriaLabel

string

[Accessibility] Defines the aria-label attribute of the toolbar.

[Parameter]
public string AriaLabel { get; set; }

ChildContent

RenderFragment

[Parameter]
public RenderFragment ChildContent { get; set; }

FillMode

string

Defines the FillMode of the toolbar.

[Parameter]
public string FillMode { get; set; }

OverflowMode

ToolBarOverflowMode

Defines how the items of the ToolBar overflow ToolBarOverflowMode.

[Parameter]
public ToolBarOverflowMode OverflowMode { get; set; }

RenderComponentClass

bool

[CascadingParameter(Name = "RenderComponentClass")]
public bool RenderComponentClass { get; set; }

RenderDivWrappers

bool

[CascadingParameter(Name = "RenderDivWrappers")]
public bool RenderDivWrappers { get; set; }

ScrollButtonsPosition

ToolBarScrollButtonsPosition

Specifies the position of the buttons when the ToolBar is Scrollable. Default value is Split.

[Parameter]
public ToolBarScrollButtonsPosition ScrollButtonsPosition { get; set; }

ScrollButtonsVisibility

ToolBarScrollButtonsVisibility

Specifies the visibility of the buttons when the ToolBar is Scrollable. Default value is Auto.

[Parameter]
public ToolBarScrollButtonsVisibility ScrollButtonsVisibility { get; set; }

Size

string

Defines the Size of the toolbar.

[Parameter]
public string Size { get; set; }

TabIndex

int

[Accessibility] Defines the tabindex passed to the inner elements of the component. Toolbar implements a roving tabindex method for navigation.

[Parameter]
public int TabIndex { get; set; }

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

GetSkippedOverflowItemIndexes()

IEnumerable<int>

public IEnumerable<int> GetSkippedOverflowItemIndexes()

Returns:

IEnumerable<int>

OnAfterRenderAsync(bool)

Task

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters:firstRenderboolReturns:

Task

Overrides: BaseComponent.OnAfterRenderAsync(bool)