New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

FloatingToolBar

Class

Kendo UI FloatingToolBar component

Definition

Namespace:Kendo.Mvc.UI

Assembly:Kendo.Mvc.dll

Syntax:

public class FloatingToolBar : WidgetBase, IWidget, IHtmlAttributesContainer, IScriptableComponent

Inheritance: objectWidgetBaseFloatingToolBar

Implements: IHtmlAttributesContainerIScriptableComponentIWidget

Inherited Members WidgetBase.Render()WidgetBase.VerifySettings()WidgetBase.ToHtmlString()WidgetBase.GetHtml(bool)WidgetBase.GetInitializator()WidgetBase.WriteLicensingScript(TextWriter)WidgetBase.SerializeSettings()WidgetBase.WriteDeferredStyles(TextWriter)WidgetBase.DeferStyles()WidgetBase.ToClientTemplate()WidgetBase.WriteTrialMessage(HtmlTextWriter)WidgetBase.InitializerWidgetBase.EventsWidgetBase.NameWidgetBase.IdWidgetBase.ShouldSanitezeIdWidgetBase.ModelMetadataWidgetBase.HtmlAttributesWidgetBase.ScriptAttributesWidgetBase.ViewContextWidgetBase.ViewDataWidgetBase.IsSelfInitializedWidgetBase.IsInClientTemplateWidgetBase.HasDeferredInitializationWidgetBase.SelectorWidgetBase.HasClientComponentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

FloatingToolBar(ViewContext, IJavaScriptInitializer, IUrlGenerator)

Initializes a new instance of the FloatingToolBar class.

public FloatingToolBar(ViewContext viewContext, IJavaScriptInitializer initializer, IUrlGenerator urlGenerator)

Parameters:viewContextViewContext

The view context

initializerIJavaScriptInitializer

The JavaScriptInitializer

urlGeneratorIUrlGenerator

The URL generator.

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.

public string Anchor { get; set; }

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.

public string AriaLabel { get; set; }

ContainerAlign

FloatingToolBarContainerAlignSettings

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.

public FloatingToolBarContainerAlignSettings ContainerAlign { get; set; }

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.

public bool? Draggable { get; set; }

FillMode

FillMode?

public FillMode? FillMode { get; set; }

Items

List<ToolBarItem>

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.

public List<ToolBarItem> Items { get; set; }

Margin

FloatingToolBarMarginSettings

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

public FloatingToolBarMarginSettings Margin { get; set; }

Messages

FloatingToolBarMessagesSettings

Specifies the localizable messages of the FloatingToolBar.

public FloatingToolBarMessagesSettings Messages { get; set; }

Overflow

FloatingToolBarOverflowSettings

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

public FloatingToolBarOverflowSettings Overflow { get; set; }

Position

FloatingToolBarPosition?

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

public FloatingToolBarPosition? Position { get; set; }

Size

ComponentSize?

public ComponentSize? Size { get; set; }

Visible

bool?

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

public bool? Visible { get; set; }

Methods

Serialize()

public override IDictionary<string, object> Serialize()

Returns:

IDictionary<string, object>

Overrides: WidgetBase.Serialize()

WriteHtml(HtmlTextWriter)

Writes the HTML.

protected override void WriteHtml(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

The HtmlTextWriter.

Overrides: WidgetBase.WriteHtml(HtmlTextWriter)

WriteInitializationScript(TextWriter)

Writes the initialization script.

public override void WriteInitializationScript(TextWriter writer)

Parameters:writerTextWriter

The TextWriter.

Overrides: WidgetBase.WriteInitializationScript(TextWriter)