ScrollViewBuilder
Properties
WriteAction - Func
Methods
ContentHeight(System.Int32)
The height of the ScrollView content.
Parameters
value - System.Int32
The value that configures the content height.
DataSource(System.Action)
Configure the DataSource of the component
Parameters
configurator - System.Action<DataSourceBuilder>
The action that configures the Kendo.Mvc.UI.Fluent.ScrollViewBuilder.DataSource(System.Action{Kendo.Mvc.UI.Fluent.DataSourceBuilder{System.Object}}).
DataSource(System.String)
Parameters
dataSourceId - System.String
Items(System.Action)
Defines the items in the scrollview
Parameters
addAction - System.Action<ScrollViewItemFactory>
The add action.
ARIATemplate(System.String)
Specifies a template is used to populate an aria-live element that anounces which is the current item.
Parameters
value - System.String
The value for ARIATemplate
ARIATemplateId(System.String)
Specifies a template is used to populate an aria-live element that anounces which is the current item.
Parameters
templateId - System.String
The ID of the template element for ARIATemplate
ARIATemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
Specifies a template is used to populate an aria-live element that anounces which is the current item.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for ARIATemplate
ARIATemplateHandler(System.String)
Specifies a template is used to populate an aria-live element that anounces which is the current item.
Parameters
templateHandler - System.String
The handler that returs the template for ARIATemplate
ARIATemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
Specifies a template is used to populate an aria-live element that anounces which is the current item.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the ariatemplate.
AutoBind(System.Boolean)
If set to false the widget will not bind to the DataSource during initialization.
Parameters
value - System.Boolean
The value for AutoBind
BounceVelocityThreshold(System.Double)
The intensity of the swipe after which the swipe will result in a bounce effect when the user scrolls to the next page. Higher values require more accelerative swipe to notice the bounce effect when a page is changed.
Parameters
value - System.Double
The value for BounceVelocityThreshold
Duration(System.Double)
The duration (in milliseconds) for the ScrollView to snap to the current page after the user releases it.
Parameters
value - System.Double
The value for Duration
EmptyTemplate(System.String)
The template for rendering the pages without content. By default, the ScrollView renders a blank page.
Parameters
value - System.String
The value for EmptyTemplate
EmptyTemplateId(System.String)
The template for rendering the pages without content. By default, the ScrollView renders a blank page.
Parameters
templateId - System.String
The ID of the template element for EmptyTemplate
EmptyTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template for rendering the pages without content. By default, the ScrollView renders a blank page.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for EmptyTemplate
EmptyTemplateHandler(System.String)
The template for rendering the pages without content. By default, the ScrollView renders a blank page.
Parameters
templateHandler - System.String
The handler that returs the template for EmptyTemplate
EmptyTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template for rendering the pages without content. By default, the ScrollView renders a blank page.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the emptytemplate.
EnablePager(System.Boolean)
If set to true, the ScrollView will display a pager. By default, the pager is enabled.
Parameters
value - System.Boolean
The value for EnablePager
Messages(System.Action)
Defines the messages that are set as aria-lables for the previous and next buttons.
Parameters
configurator - System.Action<ScrollViewMessagesSettingsBuilder>
The configurator for the messages setting.
Navigatable(System.Boolean)
If set to true enables the built-in keyboard navigation
Parameters
value - System.Boolean
The value for Navigatable
Navigatable()
If set to true enables the built-in keyboard navigation
Pageable(System.Action)
If set to true the grid will display a pager. By default paging is disabled.Can be set to a JavaScript object which represents the pager configuration.
Parameters
configurator - System.Action<ScrollViewPageableSettingsBuilder>
The configurator for the pageable setting.
Pageable()
If set to true the grid will display a pager. By default paging is disabled.Can be set to a JavaScript object which represents the pager configuration.
Pageable(System.Boolean)
If set to true the grid will display a pager. By default paging is disabled.Can be set to a JavaScript object which represents the pager configuration.
Parameters
enabled - System.Boolean
Enables or disables the pageable option.
Page(System.Double)
The initial page that will be displayed.
Parameters
value - System.Double
The value for Page
PagerOverlay(System.String)
Sets an overlay background color for the pager. It can be configured to one of the three possible values: - none - no background overlay is set - dark - sets a dark-colored background overlay - light - sets a light-colored background overlay
Parameters
value - System.String
The value for PagerOverlay
Template(System.String)
The template for rendering the content of the pages. By default, the ScrollView renders a div element for every page.
Parameters
value - System.String
The value for Template
TemplateId(System.String)
The template for rendering the content of the pages. By default, the ScrollView renders a div element for every page.
Parameters
templateId - System.String
The ID of the template element for Template
TemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template for rendering the content of the pages. By default, the ScrollView renders a div element for every page.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for Template
TemplateHandler(System.String)
The template for rendering the content of the pages. By default, the ScrollView renders a div element for every page.
Parameters
templateHandler - System.String
The handler that returs the template for Template
Template(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template for rendering the content of the pages. By default, the ScrollView renders a div element for every page.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the template.
VelocityThreshold(System.Double)
The length of the horizontal swipe after which a swipe will navigate to the next page - as opposed to snapping back to the current page. Higher values require long area swipes to navigate to the next page.
Parameters
value - System.Double
The value for VelocityThreshold
ContentHeight(System.String)
The height of the ScrollView content.
Parameters
value - System.String
The value for ContentHeight
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<ScrollViewEventBuilder>
The client events action.
Example
@(Html.Kendo().ScrollView()
.Name("ScrollView")
.Events(events => events
.Change("onChange")
)
)
ToComponent()
Returns the internal view component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
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.
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.
Render()
Renders the component in place.
ToHtmlString()
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.