ActionSheetBuilder
Properties
WriteAction - Func
Methods
Animation(System.Boolean)
Disables or opens the animation.
Parameters
value - System.Boolean
The value that will disable the animation. This property has effect only in adaptive mode. True is not a valid configuration.
RETURNS
Returns the current instance of ActionSheetBuilder .
Animation(System.Action)
Configures the opening and closing animations of the ActionSheet.
Parameters
configurator - System.Action<PopupAnimationBuilder>
The configurator that will configure the opening and closing animation.
RETURNS
Returns the current instance of ActionSheetBuilder .
ActionButtons(System.Action)
A JavaScript array that contains the ActionSheet's action buttons configuration. They will be rendered in the footer of the widget.
Parameters
configurator - System.Action<ActionSheetActionButtonFactory>
The configurator for the actionbuttons setting.
RETURNS
Returns the current instance of ActionSheetBuilder .
Adaptive(System.Boolean)
When the ActionSheet is adaptive, it occupies the full width of the screen and has the option to cover the entire screen if the fullscreen is set to true as well.
Parameters
value - System.Boolean
The value for Adaptive
RETURNS
Returns the current ActionSheetBuilder instance.
Adaptive()
When the ActionSheet is adaptive, it occupies the full width of the screen and has the option to cover the entire screen if the fullscreen is set to true as well.
RETURNS
Returns the current ActionSheetBuilder instance.
CloseButton(System.Boolean)
Whether a close button would be rendered in the titlebar. A title needs to be set to get the titlebar rendered.
Parameters
value - System.Boolean
The value for CloseButton
RETURNS
Returns the current ActionSheetBuilder instance.
CloseButton()
Whether a close button would be rendered in the titlebar. A title needs to be set to get the titlebar rendered.
RETURNS
Returns the current ActionSheetBuilder instance.
CloseOnClick(System.Boolean)
Determines whether the ActionSheet will close when clicking outside of it. If set to false, the ActionSheet will remain open until explicitly closed through code or by clicking the close button (if enabled).
Parameters
value - System.Boolean
The value for CloseOnClick
RETURNS
Returns the current ActionSheetBuilder instance.
ContentTemplate(System.String)
The text or the function whose result will be shown within the ActionSheet. By default, the ActionSheet will display the content of the target element. The content template will be disregarded if there are items defined in the widget options.
Parameters
value - System.String
The value for ContentTemplate
RETURNS
Returns the current ActionSheetBuilder instance.
ContentTemplateId(System.String)
The text or the function whose result will be shown within the ActionSheet. By default, the ActionSheet will display the content of the target element. The content template will be disregarded if there are items defined in the widget options.
Parameters
templateId - System.String
The ID of the template element for ContentTemplate
RETURNS
Returns the current ActionSheetBuilder instance.
ContentTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The text or the function whose result will be shown within the ActionSheet. By default, the ActionSheet will display the content of the target element. The content template will be disregarded if there are items defined in the widget options.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for ContentTemplate
RETURNS
Returns the current ActionSheetBuilder instance.
ContentTemplateHandler(System.String)
The text or the function whose result will be shown within the ActionSheet. By default, the ActionSheet will display the content of the target element. The content template will be disregarded if there are items defined in the widget options.
Parameters
templateHandler - System.String
The handler that returs the template for ContentTemplate
RETURNS
Returns the current ActionSheetBuilder instance.
ContentTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The text or the function whose result will be shown within the ActionSheet. By default, the ActionSheet will display the content of the target element. The content template will be disregarded if there are items defined in the widget options.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the contenttemplate.
RETURNS
Returns the current ActionSheetBuilder instance.
FooterTemplate(System.String)
The text or the function whose result will be shown within the footer of the ActionSheet. The footer template will be disregarded if there are actionButtons defined in the widget options.
Parameters
value - System.String
The value for FooterTemplate
RETURNS
Returns the current ActionSheetBuilder instance.
FooterTemplateId(System.String)
The text or the function whose result will be shown within the footer of the ActionSheet. The footer template will be disregarded if there are actionButtons defined in the widget options.
Parameters
templateId - System.String
The ID of the template element for FooterTemplate
RETURNS
Returns the current ActionSheetBuilder instance.
FooterTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The text or the function whose result will be shown within the footer of the ActionSheet. The footer template will be disregarded if there are actionButtons defined in the widget options.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for FooterTemplate
RETURNS
Returns the current ActionSheetBuilder instance.
FooterTemplateHandler(System.String)
The text or the function whose result will be shown within the footer of the ActionSheet. The footer template will be disregarded if there are actionButtons defined in the widget options.
Parameters
templateHandler - System.String
The handler that returs the template for FooterTemplate
RETURNS
Returns the current ActionSheetBuilder instance.
FooterTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The text or the function whose result will be shown within the footer of the ActionSheet. The footer template will be disregarded if there are actionButtons defined in the widget options.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the footertemplate.
RETURNS
Returns the current ActionSheetBuilder instance.
Fullscreen(System.Boolean)
Specifies whether the adaptive actionsheet would cover the entire screen when opened.
Parameters
value - System.Boolean
The value for Fullscreen
RETURNS
Returns the current ActionSheetBuilder instance.
Fullscreen()
Specifies whether the adaptive actionsheet would cover the entire screen when opened.
RETURNS
Returns the current ActionSheetBuilder instance.
Items(System.Action)
A JavaScript array that contains the ActionSheet's items configuration.
Parameters
configurator - System.Action<ActionSheetItemFactory>
The configurator for the items setting.
RETURNS
Returns the current instance of ActionSheetBuilder .
StartButton(System.Action)
When configured, a start button will be rendered in the left side of the header section of the ActionSheet. Typically used for navigation or back functionality. The button is only visible when title is also specified.
Parameters
configurator - System.Action<ActionSheetStartButtonSettingsBuilder>
The configurator for the startbutton setting.
RETURNS
Returns the current instance of ActionSheetBuilder .
Subtitle(System.String)
Specifies the subtitle of the component. Requires the title to be configured in order to have the titlebar rendered.
Parameters
value - System.String
The value for Subtitle
RETURNS
Returns the current ActionSheetBuilder instance.
Title(System.String)
Specifies the title of the component
Parameters
value - System.String
The value for Title
RETURNS
Returns the current ActionSheetBuilder instance.
ActionButtonsAlignment(Kendo.Mvc.UI.ActionButtonsAlignment)
Controls the alignment of the action buttons in the footer. This configuation works only in horizontal mode.
Parameters
value - ActionButtonsAlignment
The value for ActionButtonsAlignment
RETURNS
Returns the current ActionSheetBuilder instance.
ActionButtonsOrientation(Kendo.Mvc.UI.ActionButtonsOrientation)
Determines the orientation of the action buttons.
Parameters
value - ActionButtonsOrientation
The value for ActionButtonsOrientation
RETURNS
Returns the current ActionSheetBuilder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<ActionSheetEventBuilder>
The client events action.
RETURNS
Returns the current ActionSheetBuilder instance.
Example
@(Html.Kendo().ActionSheet()
.Name("ActionSheet")
.Events(events => events
.Activate("onActivate")
)
)
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
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
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
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.