Class SpeedDialBuilder

Inheritance

System.Object

ControlBuilder

SpeedDialBuilder

Inherited Members

ControlBuilder.Context

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.EJ2.Buttons

Assembly: Syncfusion.EJ2.dll

Syntax

public class SpeedDialBuilder : ControlBuilder

Constructors

SpeedDialBuilder()

Declaration

public SpeedDialBuilder()

SpeedDialBuilder(SpeedDial)

Declaration

public SpeedDialBuilder(SpeedDial model)

Parameters

Type	Name	Description
SpeedDial	model

Fields

model

Declaration

public SpeedDial model

Field Value

Type	Description
SpeedDial

Properties

HtmlAttr

Declaration

public IDictionary<string, object> HtmlAttr { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Output

Declaration

public override TextWriter Output { get; set; }

Property Value

Type	Description
System.IO.TextWriter

Overrides

ControlBuilder.Output

Methods

Animation(SpeedDialAnimationSettings)

Provides options to customize the animation applied while opening and closing the popup of speed dial {% codeBlock src='speeddial/animation/index.md' %}{% endcodeBlock %}

Declaration

public SpeedDialBuilder Animation(SpeedDialAnimationSettings animation)

Parameters

Type	Name	Description
SpeedDialAnimationSettings	animation

Returns

Type	Description
SpeedDialBuilder

Animation(Action<SpeedDialAnimationSettingsBuilder>)

Declaration

public SpeedDialBuilder Animation(Action<SpeedDialAnimationSettingsBuilder> animation)

Parameters

Type	Name	Description
System.Action<SpeedDialAnimationSettingsBuilder>	animation

Returns

Type	Description
SpeedDialBuilder

BeforeClose(String)

Event callback that is raised before the speed dial popup is closed.

Declaration

public SpeedDialBuilder BeforeClose(string beforeClose)

Parameters

Type	Name	Description
System.String	beforeClose

Returns

Type	Description
SpeedDialBuilder

BeforeItemRender(String)

Event callback that is raised before rendering the speed dial item.

Declaration

public SpeedDialBuilder BeforeItemRender(string beforeItemRender)

Parameters

Type	Name	Description
System.String	beforeItemRender

Returns

Type	Description
SpeedDialBuilder

BeforeOpen(String)

Event callback that is raised before the speed dial popup is opened.

Declaration

public SpeedDialBuilder BeforeOpen(string beforeOpen)

Parameters

Type	Name	Description
System.String	beforeOpen

Returns

Type	Description
SpeedDialBuilder

Clicked(String)

Event callback that is raised when a speed dial action item is clicked.

Declaration

public SpeedDialBuilder Clicked(string clicked)

Parameters

Type	Name	Description
System.String	clicked

Returns

Type	Description
SpeedDialBuilder

CloseIconCss(String)

Defines one or more CSS classes to include an icon or image to denote the speed dial is opened and displaying menu items.

Declaration

public SpeedDialBuilder CloseIconCss(string closeIconCss)

Parameters

Type	Name	Description
System.String	closeIconCss

Returns

Type	Description
SpeedDialBuilder

Content(String)

Defines the content for the button of SpeedDial.

Declaration

public SpeedDialBuilder Content(string content)

Parameters

Type	Name	Description
System.String	content

Returns

Type	Description
SpeedDialBuilder

ContentTemplate(Action<Object>)

Declaration

public SpeedDialBuilder ContentTemplate(Action<object> template)

Parameters

Type	Name	Description
System.Action<System.Object>	template

Returns

Type	Description
SpeedDialBuilder

ContentTemplate(Func<Object, Object>)

Declaration

public SpeedDialBuilder ContentTemplate(Func<object, object> template)

Parameters

Type	Name	Description
System.Func<System.Object, System.Object>	template

Returns

Type	Description
SpeedDialBuilder

Created(String)

Event callback that is raised after rendering the speed dial.

Declaration

public SpeedDialBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
SpeedDialBuilder

CssClass(String)

Defines one or more CSS classes to customize the appearance of SpeedDial.

Declaration

public SpeedDialBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
SpeedDialBuilder

Direction(LinearDirection)

Defines the speed dial item display direction when mode is linear . The possible values are Up Down Left Right Auto

Declaration

public SpeedDialBuilder Direction(LinearDirection direction)

Parameters

Type	Name	Description
LinearDirection	direction

Returns

Type	Description
SpeedDialBuilder

Disabled(Boolean)

Defines whether to enable or disable the SpeedDial.

Declaration

public SpeedDialBuilder Disabled(bool disabled = true)

Parameters

Type	Name	Description
System.Boolean	disabled

Returns

Type	Description
SpeedDialBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads.

Declaration

public SpeedDialBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
SpeedDialBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration

public SpeedDialBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
SpeedDialBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public SpeedDialBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
SpeedDialBuilder

IconPosition(IconPosition)

Defines the position of icon in the button of speed dial. The possible values are: Left Right

Declaration

public SpeedDialBuilder IconPosition(IconPosition iconPosition)

Parameters

Type	Name	Description
IconPosition	iconPosition

Returns

Type	Description
SpeedDialBuilder

Items(Action<SpeedDialItemBuilder>)

Declaration

public SpeedDialBuilder Items(Action<SpeedDialItemBuilder> items)

Parameters

Type	Name	Description
System.Action<SpeedDialItemBuilder>	items

Returns

Type	Description
SpeedDialBuilder

Items(List<SpeedDialItem>)

Defines the list of SpeedDial items.

Declaration

public SpeedDialBuilder Items(List<SpeedDialItem> items)

Parameters

Type	Name	Description
System.Collections.Generic.List<SpeedDialItem>	items

Returns

Type	Description
SpeedDialBuilder

ItemTemplate(String)

Defines the template content for the speed dial item. {% codeBlock src='speeddial/itemTemplate/index.md' %}{% endcodeBlock %}

Declaration

public SpeedDialBuilder ItemTemplate(string itemTemplate)

Parameters

Type	Name	Description
System.String	itemTemplate

Returns

Type	Description
SpeedDialBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public SpeedDialBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
SpeedDialBuilder

Modal(Boolean)

Defines whether the speed dial popup can be displayed as modal or modal less. When enabled, the Speed dial creates an overlay that disables interaction with other elements other than speed dial items. If user clicks anywhere other than speed dial items then popup will get closed.

Declaration

public SpeedDialBuilder Modal(bool modal = true)

Parameters

Type	Name	Description
System.Boolean	modal

Returns

Type	Description
SpeedDialBuilder

Mode(SpeedDialMode)

Defines the display mode of speed dial action items. The possible values are: Linear Radial {% codeBlock src='speeddial/mode/index.md' %}{% endcodeBlock %}

Declaration

public SpeedDialBuilder Mode(SpeedDialMode mode)

Parameters

Type	Name	Description
SpeedDialMode	mode

Returns

Type	Description
SpeedDialBuilder

OnClose(String)

Event callback that is raised when the SpeedDial popup is closed.

Declaration

public SpeedDialBuilder OnClose(string onClose)

Parameters

Type	Name	Description
System.String	onClose

Returns

Type	Description
SpeedDialBuilder

OnOpen(String)

Event callback that is raised when the SpeedDial popup is opened.

Declaration

public SpeedDialBuilder OnOpen(string onOpen)

Parameters

Type	Name	Description
System.String	onOpen

Returns

Type	Description
SpeedDialBuilder

OpenIconCss(String)

Defines one or more CSS classes to include an icon or image for the button of SpeedDial when it's closed.

Declaration

public SpeedDialBuilder OpenIconCss(string openIconCss)

Parameters

Type	Name	Description
System.String	openIconCss

Returns

Type	Description
SpeedDialBuilder

OpensOnHover(Boolean)

Defines whether to open the popup when the button of SpeedDial is hovered. By default, SpeedDial opens popup on click action.

Declaration

public SpeedDialBuilder OpensOnHover(bool opensOnHover = true)

Parameters

Type	Name	Description
System.Boolean	opensOnHover

Returns

Type	Description
SpeedDialBuilder

PopupTemplate(String)

Defines a template content for popup of SpeedDial.

Declaration

public SpeedDialBuilder PopupTemplate(string popupTemplate)

Parameters

Type	Name	Description
System.String	popupTemplate

Returns

Type	Description
SpeedDialBuilder

Position(FabPosition)

Defines the position of the button of Speed Dial relative to target. Defines the position of the FAB relative to target. The possible values are: TopLeft: Positions the FAB at the target's top left corner. TopCenter: Positions the FAB at the target's top left corner. TopRight: Positions the FAB at the target's top left corner. MiddleLeft: Positions the FAB at the target's top left corner. MiddleCenter: Positions the FAB at the target's top left corner. MiddleRight: Positions the FAB at the target's top left corner. BottomLeft: Positions the FAB at the target's top left corner. BottomCenter: Places the FAB on the bottom-center position of the target. BottomRight: Positions the FAB at the target's bottom right corner.

Declaration

public SpeedDialBuilder Position(FabPosition position)

Parameters

Type	Name	Description
FabPosition	position

Returns

Type	Description
SpeedDialBuilder

RadialSettings(SpeedDialRadialSettings)

Provides the options to customize the speed dial action buttons when mode of speed dial is radial {% codeBlock src='speeddial/radialSettings/index.md' %}{% endcodeBlock %}

Declaration

public SpeedDialBuilder RadialSettings(SpeedDialRadialSettings radialSettings)

Parameters

Type	Name	Description
SpeedDialRadialSettings	radialSettings

Returns

Type	Description
SpeedDialBuilder

RadialSettings(Action<SpeedDialRadialSettingsBuilder>)

Declaration

public SpeedDialBuilder RadialSettings(Action<SpeedDialRadialSettingsBuilder> radialSettings)

Parameters

Type	Name	Description
System.Action<SpeedDialRadialSettingsBuilder>	radialSettings

Returns

Type	Description
SpeedDialBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
System.Web.HtmlString

Target(String)

Defines the selector that points to the element in which the button of SpeedDial will be positioned. By default button is positioned based on viewport of browser. The target element must have relative position, else Button will get positioned based on the closest element which has relative position.

Declaration

public SpeedDialBuilder Target(string target)

Parameters

Type	Name	Description
System.String	target

Returns

Type	Description
SpeedDialBuilder

Visible(Boolean)

Defines whether the SpeedDial is visible or hidden.

Declaration

public SpeedDialBuilder Visible(bool visible = true)

Parameters

Type	Name	Description
System.Boolean	visible

Returns

Type	Description
SpeedDialBuilder