Class MobileScrollpanelPropertiesBuilder
Inheritance
Inherited Members
Namespace: Syncfusion.JavaScript.Mobile
Assembly: Syncfusion.EJ.dll
Syntax
public class MobileScrollpanelPropertiesBuilder : IPropertiesBuilder, IHtmlString
Constructors
MobileScrollpanelPropertiesBuilder(MobileScrollpanel)
Initializes a new instance of the MobileScrollpanelPropertiesBuilder class.
Declaration
public MobileScrollpanelPropertiesBuilder(MobileScrollpanel MobileScrollpanel)
Parameters
Type | Name | Description |
---|---|---|
MobileScrollpanel | MobileScrollpanel | The mobile scrollpanel. |
Methods
AllowPullToRefresh(Boolean)
Enables AllowPullToRefresh.
Declaration
public MobileScrollpanelPropertiesBuilder AllowPullToRefresh(bool allowPullToRefresh)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | allowPullToRefresh | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
BounceEasing(String)
Bounces the easing.
Declaration
public MobileScrollpanelPropertiesBuilder BounceEasing(string bounceEasing)
Parameters
Type | Name | Description |
---|---|---|
System.String | bounceEasing | The bounce easing. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
BounceTime(Int32)
Specifies the bouncing time when bouncing behaviour is .
Declaration
public MobileScrollpanelPropertiesBuilder BounceTime(int bounceTime)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | bounceTime | The bounce time. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
ClientSideEvents(Action<MobileScrollpanelClientSideEventsBuilder>)
Clients the side events.
Declaration
public MobileScrollpanelPropertiesBuilder ClientSideEvents(Action<MobileScrollpanelClientSideEventsBuilder> clientSideEvents)
Parameters
Type | Name | Description |
---|---|---|
System.Action<MobileScrollpanelClientSideEventsBuilder> | clientSideEvents | The client side events. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
CssClass(String)
CssClass the specified cssClass.
Declaration
public MobileScrollpanelPropertiesBuilder CssClass(string cssClass)
Parameters
Type | Name | Description |
---|---|---|
System.String | cssClass | The CssClass. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
DirectionLockThreshold(Int32)
Specifies the value for direction lock threshold.
Declaration
public MobileScrollpanelPropertiesBuilder DirectionLockThreshold(int directionLockThreshold)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | directionLockThreshold | The direction lock threshold. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
DisableMouse(Boolean)
Specifies whether to disable mouse.
Declaration
public MobileScrollpanelPropertiesBuilder DisableMouse(bool disableMouse)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disableMouse | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
DisablePointer(Boolean)
Specifies whether to disable pointer.
Declaration
public MobileScrollpanelPropertiesBuilder DisablePointer(bool disablePointer)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disablePointer | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
DisableTouch(Boolean)
Specifies whether to disable touch.
Declaration
public MobileScrollpanelPropertiesBuilder DisableTouch(bool disableTouch)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disableTouch | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
DisplacementTime(Int32)
Displacements the time.
Declaration
public MobileScrollpanelPropertiesBuilder DisplacementTime(int displacementTime)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | displacementTime | The displacement time. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
DisplacementValue(Int32)
Displacements the value.
Declaration
public MobileScrollpanelPropertiesBuilder DisplacementValue(int displacementValue)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | displacementValue | The displacement value. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
EnableBounce(Boolean)
Specifies whether to enable bouncing behaviour.
Declaration
public MobileScrollpanelPropertiesBuilder EnableBounce(bool enableBounce)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableBounce | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
Enabled(Boolean)
Specifies whether to enable or disable the control.
Declaration
public MobileScrollpanelPropertiesBuilder Enabled(bool enabled)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enabled | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |
EnableDisplacement(Boolean)
Enables the displacement.
Declaration
public MobileScrollpanelPropertiesBuilder EnableDisplacement(bool enableDisplacement)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableDisplacement | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
EnableFade(Boolean)
Specifies whether need to fade the scrollbars.
Declaration
public MobileScrollpanelPropertiesBuilder EnableFade(bool enableFade)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableFade | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |
EnableHorizontalScroll(Boolean)
Specifies whether need to enable the horizontal scrolling.
Declaration
public MobileScrollpanelPropertiesBuilder EnableHorizontalScroll(bool enableHorizontalScroll)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableHorizontalScroll | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |
EnableInteraction(Boolean)
Specifies whether need to enable the interactive scrollbars.
Declaration
public MobileScrollpanelPropertiesBuilder EnableInteraction(bool enableInteraction)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableInteraction | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |
EnableKeys(Boolean)
Specifies whether to enable keys.
Declaration
public MobileScrollpanelPropertiesBuilder EnableKeys(bool enableKeys)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableKeys | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
EnableMouseWheel(Boolean)
Specifies whether to enable mouse wheel scrolling.
Declaration
public MobileScrollpanelPropertiesBuilder EnableMouseWheel(bool enableMouseWheel)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableMouseWheel | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |
EnableNativeScrolling(Boolean)
Specifies whether to enable device's native scroll behaviour.
Declaration
public MobileScrollpanelPropertiesBuilder EnableNativeScrolling(bool enableNativeScrolling)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableNativeScrolling | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
EnablePersistence(Boolean)
Specifies to maintain the current model value to browser cookies for state maintenance. While refresh the page, the model value will get apply to the control from browser cookies.
Declaration
public MobileScrollpanelPropertiesBuilder EnablePersistence(bool enablePersistence)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enablePersistence | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
EnableResize(Boolean)
Specifies whether need to resize the scrollbar.
Declaration
public MobileScrollpanelPropertiesBuilder EnableResize(bool enableResize)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableResize | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |
EnableShrink(Boolean)
Specifies whether need to shrink the scrollbars.
Declaration
public MobileScrollpanelPropertiesBuilder EnableShrink(bool enableShrink)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableShrink | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |
EnableTransform(Boolean)
Specifies whether to enable transform style for the control.
Declaration
public MobileScrollpanelPropertiesBuilder EnableTransform(bool enableTransform)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableTransform | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
EnableTransition(Boolean)
Specifies whether to enable transition effect for the control.
Declaration
public MobileScrollpanelPropertiesBuilder EnableTransition(bool enableTransition)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableTransition | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
EnableVerticalScroll(Boolean)
Specifies whether need to enable the vertical scrolling.
Declaration
public MobileScrollpanelPropertiesBuilder EnableVerticalScroll(bool enableVerticalScroll)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableVerticalScroll | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |
EnableZoom(Boolean)
Specifies whether to enable zooming.
Declaration
public MobileScrollpanelPropertiesBuilder EnableZoom(bool enableZoom)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enableZoom | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |
EventPassthrough(String)
Events the passthrough.
Declaration
public MobileScrollpanelPropertiesBuilder EventPassthrough(string eventPassthrough)
Parameters
Type | Name | Description |
---|---|---|
System.String | eventPassthrough | The event passthrough. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
InvertWheel(Boolean)
Specifies whether to enable invert wheel.
Declaration
public MobileScrollpanelPropertiesBuilder InvertWheel(bool invertWheel)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | invertWheel | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
IsRelative(Boolean)
Specifies whether need to style the target element with relative position.
Declaration
public MobileScrollpanelPropertiesBuilder IsRelative(bool isRelative)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | isRelative | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |
MaximumZoom(Int32)
Specifies the maximum zoom value.
Declaration
public MobileScrollpanelPropertiesBuilder MaximumZoom(int maximumZoom)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | maximumZoom | The zoom maximum. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
MinimumZoom(Int32)
Specifies the minimum zoom value.
Declaration
public MobileScrollpanelPropertiesBuilder MinimumZoom(int minimumZoom)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | minimumZoom |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
Momentum(Boolean)
Momentums the specified momentum.
Declaration
public MobileScrollpanelPropertiesBuilder Momentum(bool momentum)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | momentum | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
PreventDefault(Boolean)
Specifies whether to prevent default events.
Declaration
public MobileScrollpanelPropertiesBuilder PreventDefault(bool preventDefault)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | preventDefault | if set to |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
PullToRefreshSettings(Action<MobileScrollpanelPullPropertiesBuilder>)
Pull to refresh settings.
Declaration
public MobileScrollpanelPropertiesBuilder PullToRefreshSettings(Action<MobileScrollpanelPullPropertiesBuilder> pullToRefreshSettings)
Parameters
Type | Name | Description |
---|---|---|
System.Action<MobileScrollpanelPullPropertiesBuilder> | pullToRefreshSettings |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
Render()
Declaration
public void Render()
RenderMode(RenderMode)
Specifies the rendering mode of the control.
Declaration
public MobileScrollpanelPropertiesBuilder RenderMode(RenderMode renderMode)
Parameters
Type | Name | Description |
---|---|---|
RenderMode | renderMode | The render mode. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
ScrollHeight(String)
Specifies the scroll height of the content.
Declaration
public MobileScrollpanelPropertiesBuilder ScrollHeight(string scrollHeight)
Parameters
Type | Name | Description |
---|---|---|
System.String | scrollHeight | Height of the scroll. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
ScrollWidth(String)
Specifies the scroll width of the content.
Declaration
public MobileScrollpanelPropertiesBuilder ScrollWidth(string scrollWidth)
Parameters
Type | Name | Description |
---|---|---|
System.String | scrollWidth | Width of the scroll. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
ShowScrollbars(Boolean)
Specifies whether need to show the scroll bars.
Declaration
public MobileScrollpanelPropertiesBuilder ShowScrollbars(bool showScrollbars)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | showScrollbars |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |
StartX(Int32)
Specifies the x position on intialize.
Declaration
public MobileScrollpanelPropertiesBuilder StartX(int startX)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | startX | The start x. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
StartY(Int32)
Specifies the y position on intialize.
Declaration
public MobileScrollpanelPropertiesBuilder StartY(int startY)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | startY | The start y. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
StartZoom(Int32)
Specifies the initial zooming value.
Declaration
public MobileScrollpanelPropertiesBuilder StartZoom(int startZoom)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | startZoom | The start zoom. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
Target(String)
Targets the specified target.
Declaration
public MobileScrollpanelPropertiesBuilder Target(string target)
Parameters
Type | Name | Description |
---|---|---|
System.String | target | The target. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
TargetHeight(String)
Specifies the target element height.
Declaration
public MobileScrollpanelPropertiesBuilder TargetHeight(string targetHeight)
Parameters
Type | Name | Description |
---|---|---|
System.String | targetHeight | Height of the target. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |
TargetWidth(String)
Specifies the target element width.
Declaration
public MobileScrollpanelPropertiesBuilder TargetWidth(string targetWidth)
Parameters
Type | Name | Description |
---|---|---|
System.String | targetWidth | Width of the target. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
ToHtmlString()
Declaration
public string ToHtmlString()
Returns
Type | Description |
---|---|
System.String |
TranslateZ(String)
Translates the z.
Declaration
public MobileScrollpanelPropertiesBuilder TranslateZ(string translateZ)
Parameters
Type | Name | Description |
---|---|---|
System.String | translateZ | The translate z. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder |
WheelSpeed(Int32)
Specifies the wheel speed.
Declaration
public MobileScrollpanelPropertiesBuilder WheelSpeed(int wheelSpeed)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | wheelSpeed | The wheel speed. |
Returns
Type | Description |
---|---|
MobileScrollpanelPropertiesBuilder | MobileScrollpanelPropertiesBuilder. |