FloatingToolBarBuilder

Properties

WriteAction - Func

Methods

Items(System.Action)

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.

Parameters

configurator - System.Action<ToolBarItemFactory>

The configurator for the items setting.

RETURNS

Returns the current instance of FloatingToolBarBuilder .

Visible(System.Boolean)

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

Parameters

value - System.Boolean

The value for Visible

RETURNS

Returns the current FloatingToolBarBuilder instance.

Visible()

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

RETURNS

Returns the current FloatingToolBarBuilder instance.

Anchor(System.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.

Parameters

value - System.String

The value for Anchor

RETURNS

Returns the current FloatingToolBarBuilder instance.

Overflow(System.Action)

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

Parameters

configurator - System.Action<FloatingToolBarOverflowSettingsBuilder>

The configurator for the overflow setting.

RETURNS

Returns the current instance of FloatingToolBarBuilder .

Draggable(System.Boolean)

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.

Parameters

value - System.Boolean

The value for Draggable

RETURNS

Returns the current FloatingToolBarBuilder instance.

Draggable()

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.

RETURNS

Returns the current FloatingToolBarBuilder instance.

AriaLabel(System.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.

Parameters

value - System.String

The value for AriaLabel

RETURNS

Returns the current FloatingToolBarBuilder instance.

ContainerAlign(System.Action)

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.

Parameters

configurator - System.Action<FloatingToolBarContainerAlignSettingsBuilder>

The configurator for the containeralign setting.

RETURNS

Returns the current instance of FloatingToolBarBuilder .

Margin(System.Action)

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

Parameters

configurator - System.Action<FloatingToolBarMarginSettingsBuilder>

The configurator for the margin setting.

RETURNS

Returns the current instance of FloatingToolBarBuilder .

Messages(System.Action)

Specifies the localizable messages of the FloatingToolBar.

Parameters

configurator - System.Action<FloatingToolBarMessagesSettingsBuilder>

The configurator for the messages setting.

RETURNS

Returns the current instance of FloatingToolBarBuilder .

Position(Kendo.Mvc.UI.FloatingToolBarPosition)

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

Parameters

value - FloatingToolBarPosition

The value for Position

RETURNS

Returns the current FloatingToolBarBuilder instance.

Size(Kendo.Mvc.UI.ComponentSize)

Controls the overall physical size of the hosted ToolBar and its items. Default is Medium.

Parameters

value - ComponentSize

The value for Size

RETURNS

Returns the current FloatingToolBarBuilder instance.

FillMode(Kendo.Mvc.UI.FillMode)

Controls the way the color is applied to the hosted ToolBar and its items. Default is Solid.

Parameters

value - FillMode

The value for FillMode

RETURNS

Returns the current FloatingToolBarBuilder instance.

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<FloatingToolBarEventBuilder>

The client events action.

RETURNS

Returns the current FloatingToolBarBuilder instance.

Example

Razor

 
            @(Html.Kendo().FloatingToolBar()
                  .Name("FloatingToolBar")
                  .Events(events => events
                      .Show("onShow")
                  )
            )
             

ToComponent()

Returns the internal view component.

RETURNS

The instance that represents the component.

Expression(System.String)

Sets the name of the component.

Parameters

modelExpression - System.String

The name.

RETURNS

Returns the current instance.

Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

The name.

RETURNS

Returns the current instance.

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name.

RETURNS

Returns the current instance.

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with Kendo.Mvc.UI.Fluent.WidgetFactory.DeferredScripts(System.Boolean,System.Boolean)

Parameters

deferred - System.Boolean

RETURNS

Returns a DeferredWidgetBuilder instance.

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

RETURNS

Returns the current instance.

HtmlAttributes(System.Collections.Generic.IDictionary)

Sets the HTML attributes.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The HTML attributes.

RETURNS

Returns the current instance.

ScriptAttributes(System.Object,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Object

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

Render()

Renders the component in place.

ToHtmlString()

Returns the HTML representation of the component.

WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)

Parameters

writer - System.IO.TextWriter

encoder - System.Text.Encodings.Web.HtmlEncoder

ToClientTemplate()

Returns the client template for the component.

AsModule(System.Boolean)

Specifies whether the initialization script of the component will be rendered as a JavaScript module.

Parameters

value - System.Boolean

RETURNS

Returns the current instance.