Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / FloatingToolBarBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

FloatingToolBarBuilder

Class

Defines the fluent API for configuring the Kendo FloatingToolBar for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class FloatingToolBarBuilder : WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>FloatingToolBarBuilder

Implements: IHtmlString

Inherited Members WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.ToComponent()WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.Name(string)WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.Deferred(bool)WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.ModelMetadata(ModelMetadata)WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.HtmlAttributes(object)WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.AsModule(bool)WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.Render()WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.ScriptAttributes(object, bool)WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.ToHtmlString()WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.ToClientTemplate()WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.ToString()WidgetBuilderBase<FloatingToolBar, FloatingToolBarBuilder>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

FloatingToolBarBuilder(FloatingToolBar)

Initializes a new instance of the FloatingToolBar class.

C#
public FloatingToolBarBuilder(FloatingToolBar component)
Parameters:componentFloatingToolBar

The component.

Methods

Anchor(string)

Specifies the target element the FloatingToolBar is anchored to. When set, the widget operates in Anchored mode and positions itself relative to the specified target based on the position option. When left unset, the widget operates in Free-position mode and is positioned based on the containerAlign and margin options.

C#
public FloatingToolBarBuilder Anchor(string value)
Parameters:valuestring

The value that configures the anchor.

Returns:

FloatingToolBarBuilder

AriaLabel(string)

Specifies the aria-label attribute applied to the hosted ToolBar element, overriding the ToolBar's own default "Toolbar" label. Use this option to provide an accessible name that describes the purpose of the floating toolbar to assistive technologies.

C#
public FloatingToolBarBuilder AriaLabel(string value)
Parameters:valuestring

The value that configures the arialabel.

Returns:

FloatingToolBarBuilder

ContainerAlign(Action<FloatingToolBarContainerAlignSettingsBuilder>)

Specifies the alignment of the FloatingToolBar relative to its positioned container when the anchor option is not set (Free-position mode). This option is ignored when anchor is set.

C#
public FloatingToolBarBuilder ContainerAlign(Action<FloatingToolBarContainerAlignSettingsBuilder> configurator)
Parameters:configuratorAction<FloatingToolBarContainerAlignSettingsBuilder>

The action that configures the containeralign.

Returns:

FloatingToolBarBuilder

Draggable(bool)

Specifies whether the FloatingToolBar can be repositioned by the user through pointer dragging or keyboard-driven Move mode. When enabled, a drag handle is rendered inside the widget and the movement is clamped to remain within the browser viewport.

C#
public FloatingToolBarBuilder Draggable(bool value)
Parameters:valuebool

The value that configures the draggable.

Returns:

FloatingToolBarBuilder

Events(Action<FloatingToolBarEventBuilder>)

Configures the client-side events.

C#
public FloatingToolBarBuilder Events(Action<FloatingToolBarEventBuilder> configurator)
Parameters:configuratorAction<FloatingToolBarEventBuilder>

The client events action.

Returns:

FloatingToolBarBuilder

Example:
C#
@(Html.Kendo().FloatingToolBar()
.Name("FloatingToolBar")
.Events(events =&gt; events
.VisibleChange("onVisibleChange")
)
)

FillMode(FillMode)

C#
public FloatingToolBarBuilder FillMode(FillMode value)
Parameters:valueFillMode

The value that configures the fillmode.

Returns:

FloatingToolBarBuilder

Items(Action<ToolBarItemFactory>)

A JavaScript array that contains the configuration of the commands rendered inside the hosted ToolBar. The item configuration is identical to the ToolBar "items" configuration.

C#
public FloatingToolBarBuilder Items(Action<ToolBarItemFactory> configurator)
Parameters:configuratorAction<ToolBarItemFactory>

The action that configures the items.

Returns:

FloatingToolBarBuilder

Margin(Action<FloatingToolBarMarginSettingsBuilder>)

Specifies an additional offset, in pixels, applied to the FloatingToolBar position. The margin is applied in both Anchored and Free-position modes.

C#
public FloatingToolBarBuilder Margin(Action<FloatingToolBarMarginSettingsBuilder> configurator)
Parameters:configuratorAction<FloatingToolBarMarginSettingsBuilder>

The action that configures the margin.

Returns:

FloatingToolBarBuilder

Messages(Action<FloatingToolBarMessagesSettingsBuilder>)

Specifies the localizable messages of the FloatingToolBar.

C#
public FloatingToolBarBuilder Messages(Action<FloatingToolBarMessagesSettingsBuilder> configurator)
Parameters:configuratorAction<FloatingToolBarMessagesSettingsBuilder>

The action that configures the messages.

Returns:

FloatingToolBarBuilder

Overflow(Action<FloatingToolBarOverflowSettingsBuilder>)

Configures the overflow behavior of the hosted ToolBar. The configuration is forwarded verbatim to the hosted ToolBar instance.

C#
public FloatingToolBarBuilder Overflow(Action<FloatingToolBarOverflowSettingsBuilder> configurator)
Parameters:configuratorAction<FloatingToolBarOverflowSettingsBuilder>

The action that configures the overflow.

Returns:

FloatingToolBarBuilder

Position(FloatingToolBarPosition)

Specifies the side of the anchor target the FloatingToolBar is positioned at. Default is Top.

C#
public FloatingToolBarBuilder Position(FloatingToolBarPosition value)
Parameters:valueFloatingToolBarPosition

The value that configures the position.

Returns:

FloatingToolBarBuilder

Size(ComponentSize)

C#
public FloatingToolBarBuilder Size(ComponentSize value)
Parameters:valueComponentSize

The value that configures the size.

Returns:

FloatingToolBarBuilder

Visible(bool)

Specifies whether the FloatingToolBar is shown initially, upon widget initialization.

C#
public FloatingToolBarBuilder Visible(bool value)
Parameters:valuebool

The value that configures the visible.

Returns:

FloatingToolBarBuilder

In this article
DefinitionConstructorsFloatingToolBarBuilder(FloatingToolBar)MethodsAnchor(string)AriaLabel(string)ContainerAlign(Action<FloatingToolBarContainerAlignSettingsBuilder>)Draggable(bool)Events(Action<FloatingToolBarEventBuilder>)FillMode(FillMode)Items(Action<ToolBarItemFactory>)Margin(Action<FloatingToolBarMarginSettingsBuilder>)Messages(Action<FloatingToolBarMessagesSettingsBuilder>)Overflow(Action<FloatingToolBarOverflowSettingsBuilder>)Position(FloatingToolBarPosition)Size(ComponentSize)Visible(bool)
Not finding the help you need?
Contact Support