Class ScrollerPropertiesBuilder

Inheritance

System.Object

ScrollerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

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.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class ScrollerPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

ScrollerPropertiesBuilder()

Initializes a new instance of the ScrollerPropertiesBuilder class.

Declaration

public ScrollerPropertiesBuilder()

ScrollerPropertiesBuilder(Scroller)

Initializes a new instance of the ScrollerPropertiesBuilder class by the specified scroller object.

Declaration

public ScrollerPropertiesBuilder(Scroller scroller)

Parameters

Type	Name	Description
Scroller	scroller

Fields

scroller

Specifies the instance of the Scroller class.

Declaration

public Scroller scroller

Field Value

Type	Description
Scroller

Methods

AutoHide()

Specifies to show the scrollbar when move the cursor towards content and hide when leave the content area.

Declaration

public ScrollerPropertiesBuilder AutoHide()

Returns

Type	Description
ScrollerPropertiesBuilder

AutoHide(Boolean)

Specifies to show the scrollbar when move the cursor towards content and hide when leave the content area by the specified argument.

Declaration

public ScrollerPropertiesBuilder AutoHide(bool autoHide)

Parameters

Type	Name	Description
System.Boolean	autoHide

Returns

Type	Description
ScrollerPropertiesBuilder

ButtonSize(Int32)

Specifies the buttons size of the scrollbar.

Declaration

public ScrollerPropertiesBuilder ButtonSize(int buttonSize)

Parameters

Type	Name	Description
System.Int32	buttonSize

Returns

Type	Description
ScrollerPropertiesBuilder

ClientSideEvents(Action<ScrollerClientSideEventsBuilder>)

Specifies to trigger the scroller client side events.

Declaration

public ScrollerPropertiesBuilder ClientSideEvents(Action<ScrollerClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<ScrollerClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
ScrollerPropertiesBuilder

ContentTemplate(Action<Object>)

Specifies the content template for scroller content with web form data.

Declaration

public ScrollerPropertiesBuilder ContentTemplate(Action<object> contentTemplate)

Parameters

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

Returns

Type	Description
ScrollerPropertiesBuilder

ContentTemplate(Func<Object, Object>)

Specifies the content template for scroller content with razor view.

Declaration

public ScrollerPropertiesBuilder ContentTemplate(Func<object, object> contentTemplate)

Parameters

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

Returns

Type	Description
ScrollerPropertiesBuilder

Enabled()

Specifies the scroller control can respond to user interaction.

Declaration

public ScrollerPropertiesBuilder Enabled()

Returns

Type	Description
ScrollerPropertiesBuilder

Enabled(Boolean)

Specifies the scroller control can respond to user interaction with the specified boolean argument.

Declaration

public ScrollerPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

Returns

Type	Description
ScrollerPropertiesBuilder

EnablePersistence()

Specifies to persists the scrollbar model value even after form post back/browser refresh.

Declaration

public ScrollerPropertiesBuilder EnablePersistence()

Returns

Type	Description
ScrollerPropertiesBuilder

EnablePersistence(Boolean)

Specifies to persists the scrollbar model value even after form post back/browser refresh with the specified boolean argument.

Declaration

public ScrollerPropertiesBuilder EnablePersistence(bool enablePersistence)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
ScrollerPropertiesBuilder

EnableRTL()

Declaration

public ScrollerPropertiesBuilder EnableRTL()

Returns

Type	Description
ScrollerPropertiesBuilder

EnableRTL(Boolean)

Specifies to align the scroller content in right to left direction.

Declaration

public ScrollerPropertiesBuilder EnableRTL(bool rtl)

Parameters

Type	Name	Description
System.Boolean	rtl

Returns

Type	Description
ScrollerPropertiesBuilder

EnableTouchScroll()

Specifies to enable or disable the touch scroll.

Declaration

public ScrollerPropertiesBuilder EnableTouchScroll()

Returns

Type	Description
ScrollerPropertiesBuilder

EnableTouchScroll(Boolean)

Specifies to enable or disable the touch scroll with the specified boolean argument.

Declaration

public ScrollerPropertiesBuilder EnableTouchScroll(bool enableTouchScroll)

Parameters

Type	Name	Description
System.Boolean	enableTouchScroll

Returns

Type	Description
ScrollerPropertiesBuilder

Height(Object)

Specifies the height of the scroll panel.

Declaration

public ScrollerPropertiesBuilder Height(object height)

Parameters

Type	Name	Description
System.Object	height

Returns

Type	Description
ScrollerPropertiesBuilder

Render()

Renders the scroller instance.

Declaration

public void Render()

ScrollerSize(Int32)

Specifies the scrollbar size.

Declaration

public ScrollerPropertiesBuilder ScrollerSize(int scrollerSize)

Parameters

Type	Name	Description
System.Int32	scrollerSize

Returns

Type	Description
ScrollerPropertiesBuilder

ScrollLeft(Int32)

specifies the scroller content and scrollbars move to left position with specified value.

Declaration

public ScrollerPropertiesBuilder ScrollLeft(int scrollLeft)

Parameters

Type	Name	Description
System.Int32	scrollLeft

Returns

Type	Description
ScrollerPropertiesBuilder

ScrollOneStepBy(Int32)

Specifies the value (in pixel) to move the scrollbar position when the scrollbar button pressed.

Declaration

public ScrollerPropertiesBuilder ScrollOneStepBy(int oneStep)

Parameters

Type	Name	Description
System.Int32	oneStep

Returns

Type	Description
ScrollerPropertiesBuilder

ScrollTop(Int32)

specifies the scroller content and scrollbars move to top position with specified value.

Declaration

public ScrollerPropertiesBuilder ScrollTop(int scrollTop)

Parameters

Type	Name	Description
System.Int32	scrollTop

Returns

Type	Description
ScrollerPropertiesBuilder

TargetPane(String)

Specifies the target area in which scrollbar have to appear.

Declaration

public ScrollerPropertiesBuilder TargetPane(string TargetPane)

Parameters

Type	Name	Description
System.String	TargetPane

Returns

Type	Description
ScrollerPropertiesBuilder

ToHtmlString()

Represents an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

Width(Object)

Specifies the width of the scroll panel.

Declaration

public ScrollerPropertiesBuilder Width(object width)

Parameters

Type	Name	Description
System.Object	width

Returns

Type	Description
ScrollerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString