Class SpeedDial
Inherited Members
Namespace: Syncfusion.EJ2.Buttons
Assembly: Syncfusion.EJ2.dll
Syntax
public class SpeedDial : EJTagHelper
Constructors
SpeedDial()
Declaration
public SpeedDial()
Properties
Animation
Provides options to customize the animation applied while opening and closing the popup of speed dial {% codeBlock src='speeddial/animation/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("animation")]
public SpeedDialAnimationSettings Animation { get; set; }
Property Value
Type | Description |
---|---|
SpeedDialAnimationSettings | The default value is null |
BeforeClose
Event callback that is raised before the speed dial popup is closed.
Declaration
[HtmlAttributeName("beforeClose")]
public string BeforeClose { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeItemRender
Event callback that is raised before rendering the speed dial item.
Declaration
[HtmlAttributeName("beforeItemRender")]
public string BeforeItemRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeOpen
Event callback that is raised before the speed dial popup is opened.
Declaration
[HtmlAttributeName("beforeOpen")]
public string BeforeOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Clicked
Event callback that is raised when a speed dial action item is clicked.
Declaration
[HtmlAttributeName("clicked")]
public string Clicked { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CloseIconCss
Defines one or more CSS classes to include an icon or image to denote the speed dial is opened and displaying menu items.
Declaration
[HtmlAttributeName("closeIconCss")]
public string CloseIconCss { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Content
Defines the content for the button of SpeedDial.
Declaration
[HtmlAttributeName("content")]
public string Content { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
ContentTemplate
To get or set value for ContentTemplate.
Declaration
public MvcTemplate<object> ContentTemplate { get; set; }
Property Value
Type | Description |
---|---|
MvcTemplate<System.Object> |
Created
Event callback that is raised after rendering the speed dial.
Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CssClass
Defines one or more CSS classes to customize the appearance of SpeedDial.
Declaration
[HtmlAttributeName("cssClass")]
public string CssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Direction
Defines the speed dial item display direction when mode is linear . The possible values are Up Down Left Right Auto
Declaration
[HtmlAttributeName("direction")]
public LinearDirection Direction { get; set; }
Property Value
Type | Description |
---|---|
LinearDirection | The default value is LinearDirection.Auto |
Disabled
Defines whether to enable or disable the SpeedDial.
Declaration
[HtmlAttributeName("disabled")]
public bool Disabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
IconPosition
Defines the position of icon in the button of speed dial. The possible values are: Left Right
Declaration
[HtmlAttributeName("iconPosition")]
public IconPosition IconPosition { get; set; }
Property Value
Type | Description |
---|---|
IconPosition | The default value is IconPosition.Left |
Items
Defines the list of SpeedDial items.
Declaration
[HtmlAttributeName("items")]
public List<SpeedDialItem> Items { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<SpeedDialItem> | The default value is null |
ItemTemplate
Defines the template content for the speed dial item. {% codeBlock src='speeddial/itemTemplate/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("itemTemplate")]
public string ItemTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
[HtmlAttributeName("locale")]
public string Locale { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Modal
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
[HtmlAttributeName("modal")]
public bool Modal { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
Mode
Defines the display mode of speed dial action items. The possible values are: Linear Radial {% codeBlock src='speeddial/mode/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("mode")]
public SpeedDialMode Mode { get; set; }
Property Value
Type | Description |
---|---|
SpeedDialMode | The default value is SpeedDialMode.Linear |
OnClose
Event callback that is raised when the SpeedDial popup is closed.
Declaration
[HtmlAttributeName("onClose")]
public string OnClose { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
OnOpen
Event callback that is raised when the SpeedDial popup is opened.
Declaration
[HtmlAttributeName("onOpen")]
public string OnOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
OpenIconCss
Defines one or more CSS classes to include an icon or image for the button of SpeedDial when it's closed.
Declaration
[HtmlAttributeName("openIconCss")]
public string OpenIconCss { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
OpensOnHover
Defines whether to open the popup when the button of SpeedDial is hovered. By default, SpeedDial opens popup on click action.
Declaration
[HtmlAttributeName("opensOnHover")]
public bool OpensOnHover { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
PopupTemplate
Defines a template content for popup of SpeedDial.
Declaration
[HtmlAttributeName("popupTemplate")]
public string PopupTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Position
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
[HtmlAttributeName("position")]
public FabPosition Position { get; set; }
Property Value
Type | Description |
---|---|
FabPosition | The default value is FabPosition.BottomRight |
RadialSettings
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
[HtmlAttributeName("radialSettings")]
public SpeedDialRadialSettings RadialSettings { get; set; }
Property Value
Type | Description |
---|---|
SpeedDialRadialSettings | The default value is null |
Target
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
[HtmlAttributeName("target")]
public string Target { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Visible
Defines whether the SpeedDial is visible or hidden.
Declaration
[HtmlAttributeName("visible")]
public bool Visible { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |