Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / ScrollViewBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

ScrollViewBuilder

Class

Defines the fluent API for configuring the Kendo ScrollView for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class ScrollViewBuilder : WidgetBuilderBase<ScrollView, ScrollViewBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<ScrollView, ScrollViewBuilder>ScrollViewBuilder

Implements: IHtmlString

Inherited Members WidgetBuilderBase<ScrollView, ScrollViewBuilder>.ToComponent()WidgetBuilderBase<ScrollView, ScrollViewBuilder>.Name(string)WidgetBuilderBase<ScrollView, ScrollViewBuilder>.Deferred(bool)WidgetBuilderBase<ScrollView, ScrollViewBuilder>.ModelMetadata(ModelMetadata)WidgetBuilderBase<ScrollView, ScrollViewBuilder>.HtmlAttributes(object)WidgetBuilderBase<ScrollView, ScrollViewBuilder>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<ScrollView, ScrollViewBuilder>.AsModule(bool)WidgetBuilderBase<ScrollView, ScrollViewBuilder>.Render()WidgetBuilderBase<ScrollView, ScrollViewBuilder>.ScriptAttributes(object, bool)WidgetBuilderBase<ScrollView, ScrollViewBuilder>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<ScrollView, ScrollViewBuilder>.ToHtmlString()WidgetBuilderBase<ScrollView, ScrollViewBuilder>.ToClientTemplate()WidgetBuilderBase<ScrollView, ScrollViewBuilder>.ToString()WidgetBuilderBase<ScrollView, ScrollViewBuilder>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

ScrollViewBuilder(ScrollView)

Initializes a new instance of the ScrollView class.

C#
public ScrollViewBuilder(ScrollView component)
Parameters:componentScrollView

The component.

Methods

ARIATemplate(string)

Specifies a template is used to populate an aria-live element that anounces which is the current item.

C#
public ScrollViewBuilder ARIATemplate(string value)
Parameters:valuestring

The value that configures the ariatemplate.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.ARIATemplate("aria-template")
)

ARIATemplate<TModel>(TemplateBuilder<TModel>)

Specifies a template is used to populate an aria-live element that anounces which is the current item.

C#
public ScrollViewBuilder ARIATemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the ariatemplate.

Returns:

ScrollViewBuilder

ARIATemplateHandler(string)

Specifies a template is used to populate an aria-live element that anounces which is the current item.

C#
public ScrollViewBuilder ARIATemplateHandler(string value)
Parameters:valuestring

The value that configures the ariatemplate.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.ARIATemplateHandler("template-handler")
)

ARIATemplateId(string)

Specifies a template is used to populate an aria-live element that anounces which is the current item.

C#
public ScrollViewBuilder ARIATemplateId(string value)
Parameters:valuestring

The value that configures the ariatemplate.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.ARIATemplateId("aria-templateId")
)

ARIATemplateView(MvcHtmlString)

Specifies a template is used to populate an aria-live element that anounces which is the current item.

C#
public ScrollViewBuilder ARIATemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the ariatemplate.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.ARIATemplateView(new Microsoft.AspNetCore.Html.HtmlString("Viewing item #: data.Text # out of #: data.Total #"))
)

AutoBind(bool)

If set to false the widget will not bind to the DataSource during initialization.

C#
public ScrollViewBuilder AutoBind(bool value)
Parameters:valuebool

The value that configures the autobind.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.AutoBind(true)
)

BounceVelocityThreshold(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.

C#
public ScrollViewBuilder BounceVelocityThreshold(double value)
Parameters:valuedouble

The value that configures the bouncevelocitythreshold.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.BounceVelocityThreshold(20)
)

ContentHeight(int)

The height of the ScrollView content.

C#
public ScrollViewBuilder ContentHeight(int value)
Parameters:valueint

The value that configures the contentheight.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.ContentHeight(20)
)

ContentHeight(string)

The height of the ScrollView content.

C#
public ScrollViewBuilder ContentHeight(string value)
Parameters:valuestring

The value that configures the contentheight.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.ContentHeight("20")
)

DataSource(Action<ReadOnlyDataSourceBuilder>)

Instance of DataSource or the data that the mobile ScrollView will be bound to.

C#
public ScrollViewBuilder DataSource(Action<ReadOnlyDataSourceBuilder> configurator)
Parameters:configuratorAction<ReadOnlyDataSourceBuilder>

The value that configures the datasource.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.DataSource(d =&gt; d.Ajax())
)

DataSource(string)

C#
public ScrollViewBuilder DataSource(string dataSourceId)
Parameters:dataSourceIdstringReturns:

ScrollViewBuilder

Duration(double)

The duration (in milliseconds) for the ScrollView to snap to the current page after the user releases it.

C#
public ScrollViewBuilder Duration(double value)
Parameters:valuedouble

The value that configures the duration.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.Duration(20)
)

EmptyTemplate(string)

The template for rendering the pages without content. By default, the ScrollView renders a blank page.

C#
public ScrollViewBuilder EmptyTemplate(string value)
Parameters:valuestring

The value that configures the emptytemplate.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.EmptyTemplate("empty-template")
)

EmptyTemplate<TModel>(TemplateBuilder<TModel>)

The template for rendering the pages without content. By default, the ScrollView renders a blank page.

C#
public ScrollViewBuilder EmptyTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the emptytemplate.

Returns:

ScrollViewBuilder

EmptyTemplateHandler(string)

The template for rendering the pages without content. By default, the ScrollView renders a blank page.

C#
public ScrollViewBuilder EmptyTemplateHandler(string value)
Parameters:valuestring

The value that configures the emptytemplate.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.EmptyTemplateHandler("emptyTemplateHandler")
)

EmptyTemplateId(string)

The template for rendering the pages without content. By default, the ScrollView renders a blank page.

C#
public ScrollViewBuilder EmptyTemplateId(string value)
Parameters:valuestring

The value that configures the emptytemplate.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.EmptyTemplateId("empty-templateId")
)

EmptyTemplateView(MvcHtmlString)

The template for rendering the pages without content. By default, the ScrollView renders a blank page.

C#
public ScrollViewBuilder EmptyTemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the emptytemplate.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.EmptyTemplateView(new Microsoft.AspNetCore.Html.HtmlString("empty-template-view"))
)

EnablePager(bool)

If set to true, the ScrollView will display a pager. By default, the pager is enabled.

C#
public ScrollViewBuilder EnablePager(bool value)
Parameters:valuebool

The value that configures the enablepager.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.EnablePager(false)
)

Events(Action<ScrollViewEventBuilder>)

Configures the client-side events.

C#
public ScrollViewBuilder Events(Action<ScrollViewEventBuilder> configurator)
Parameters:configuratorAction<ScrollViewEventBuilder>

The client events action.

Returns:

ScrollViewBuilder

Example:
C#
@( Html.Kendo().ScrollView()
.Name("ScrollView")
.Events(events =&gt; events
.Change("onChange")
)
)

Items(Action<ScrollViewItemFactory>)

Contains the items of the ScrollView widget

C#
public ScrollViewBuilder Items(Action<ScrollViewItemFactory> configurator)
Parameters:configuratorAction<ScrollViewItemFactory>

The action that configures the items.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.Items(x =&gt;
{
x.Add().Content("");
})
)

Messages(Action<ScrollViewMessagesSettingsBuilder>)

Defines the messages that are set as aria-lables for the previous and next buttons.

C#
public ScrollViewBuilder Messages(Action<ScrollViewMessagesSettingsBuilder> configurator)
Parameters:configuratorAction<ScrollViewMessagesSettingsBuilder>

The action that configures the messages.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.Messages(m =&gt; m.PagerLabel("pager"))
)

Navigatable()

If set to true enables the built-in keyboard navigation

C#
public ScrollViewBuilder Navigatable()
Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.Navigatable()
)

Navigatable(bool)

If set to true enables the built-in keyboard navigation

C#
public ScrollViewBuilder Navigatable(bool value)
Parameters:valuebool

The value that configures the navigatable.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.Navigatable(true)
)

Page(double)

The initial page that will be displayed.

C#
public ScrollViewBuilder Page(double value)
Parameters:valuedouble

The value that configures the page.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.Page(20)
)

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.

C#
public ScrollViewBuilder Pageable()
Returns:

ScrollViewBuilder

Pageable(Action<ScrollViewPageableSettingsBuilder>)

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.

C#
public ScrollViewBuilder Pageable(Action<ScrollViewPageableSettingsBuilder> configurator)
Parameters:configuratorAction<ScrollViewPageableSettingsBuilder>

The action that configures the pageable.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.Pageable(p =&gt; p.ARIATemplateId("aria-templateId"))
)

Pageable(bool)

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.

C#
public ScrollViewBuilder Pageable(bool enabled)
Parameters:enabledbool

Enables or disables the pageable option.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.Pageable(true)
)

PagerOverlay(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

C#
public ScrollViewBuilder PagerOverlay(string value)
Parameters:valuestring

The value that configures the pageroverlay.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.PagerOverlay("page-overlay")
)

Template(string)

The template for rendering the content of the pages. By default, the ScrollView renders a div element for every page.

C#
public ScrollViewBuilder Template(string value)
Parameters:valuestring

The value that configures the template.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.Template("template")
)

Template<TModel>(TemplateBuilder<TModel>)

The template for rendering the content of the pages. By default, the ScrollView renders a div element for every page.

C#
public ScrollViewBuilder Template<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

ScrollViewBuilder

TemplateHandler(string)

The template for rendering the content of the pages. By default, the ScrollView renders a div element for every page.

C#
public ScrollViewBuilder TemplateHandler(string value)
Parameters:valuestring

The value that configures the template.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.TemplateHandler("template-handler")
)

TemplateId(string)

The template for rendering the content of the pages. By default, the ScrollView renders a div element for every page.

C#
public ScrollViewBuilder TemplateId(string value)
Parameters:valuestring

The value that configures the template.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.TemplateId("templateId")
)

TemplateView(MvcHtmlString)

The template for rendering the content of the pages. By default, the ScrollView renders a div element for every page.

C#
public ScrollViewBuilder TemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the template.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.TemplateView(new Microsoft.AspNetCore.Html.HtmlString("empty-template-view"))
)

VelocityThreshold(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.

C#
public ScrollViewBuilder VelocityThreshold(double value)
Parameters:valuedouble

The value that configures the velocitythreshold.

Returns:

ScrollViewBuilder

Example:
C#
@(Html.Kendo().ScrollView()
.Name("scrollView")
.VelocityThreshold(20)
)
In this article
DefinitionConstructorsScrollViewBuilder(ScrollView)MethodsARIATemplate(string)ARIATemplate<TModel>(TemplateBuilder<TModel>)ARIATemplateHandler(string)ARIATemplateId(string)ARIATemplateView(MvcHtmlString)AutoBind(bool)BounceVelocityThreshold(double)ContentHeight(int)ContentHeight(string)DataSource(Action<ReadOnlyDataSourceBuilder>)DataSource(string)Duration(double)EmptyTemplate(string)EmptyTemplate<TModel>(TemplateBuilder<TModel>)EmptyTemplateHandler(string)EmptyTemplateId(string)EmptyTemplateView(MvcHtmlString)EnablePager(bool)Events(Action<ScrollViewEventBuilder>)Items(Action<ScrollViewItemFactory>)Messages(Action<ScrollViewMessagesSettingsBuilder>)Navigatable()Navigatable(bool)Page(double)Pageable()Pageable(Action<ScrollViewPageableSettingsBuilder>)Pageable(bool)PagerOverlay(string)Template(string)Template<TModel>(TemplateBuilder<TModel>)TemplateHandler(string)TemplateId(string)TemplateView(MvcHtmlString)VelocityThreshold(double)
Not finding the help you need?
Contact Support