Class ScrollOptionsBuilder<T>

Inheritance

System.Object

ScrollOptionsBuilder<T>

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 ScrollOptionsBuilder<T>
    where T : class

Type Parameters

Name	Description
T

Constructors

ScrollOptionsBuilder(ScrollSettings)

Initializes a new instance of the class.

Declaration

public ScrollOptionsBuilder(ScrollSettings scroll)

Parameters

Type	Name	Description
ScrollSettings	scroll	It accepts the list of ScrollSettings option

Methods

AllowVirtualScrolling()

This specify the grid to to view data that you require without buffering the entire load of a huge database

Declaration

public ScrollOptionsBuilder<T> AllowVirtualScrolling()

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

AllowVirtualScrolling(Boolean)

This specify the grid to view data that you require without buffering the entire load of a huge database

Declaration

public ScrollOptionsBuilder<T> AllowVirtualScrolling(bool allowVirtualScrolling)

Parameters

Type	Name	Description
System.Boolean	allowVirtualScrolling	It accepts the boolean value and enables or disables the grid to view data that you require.

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

AutoHide()

Specifies the height and width of button in the scrollbar.

Declaration

public ScrollOptionsBuilder<T> AutoHide()

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

AutoHide(Boolean)

Specifies the height and width of button in the scrollbar.

Declaration

public ScrollOptionsBuilder<T> AutoHide(bool value)

Parameters

Type	Name	Description
System.Boolean	value	It accepts the boolean value and enables or disables the height and width of scrollbar

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

ButtonSize(Int32)

Specifies the height and width of button in the scrollbar.

Declaration

public ScrollOptionsBuilder<T> ButtonSize(int buttonSize)

Parameters

Type	Name	Description
System.Int32	buttonSize	It accepts the integer value and sets the width and height of button in scrollbar

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

EnableTouchScroll()

This specify the grid to enable/disable touch control for scrolling.

Declaration

public ScrollOptionsBuilder<T> EnableTouchScroll()

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

EnableTouchScroll(Boolean)

This specify the grid to enable/disable touch control for scrolling.

Declaration

public ScrollOptionsBuilder<T> EnableTouchScroll(bool value)

Parameters

Type	Name	Description
System.Boolean	value	It accepts the boolean value and enables or disables the touch scrolling

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

EnableVirtualization()

This specifies only the minimal pages at runtime for reducing memory consumption

Declaration

public ScrollOptionsBuilder<T> EnableVirtualization()

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

EnableVirtualization(Boolean)

This specifies only the minimal pages at runtime for reducing memory consumption

Declaration

public ScrollOptionsBuilder<T> EnableVirtualization(bool enableVirtualization)

Parameters

Type	Name	Description
System.Boolean	enableVirtualization	It accepts the boolean value and enables or disables the virtual pages

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

FrozenColumns(Int32)

This specify the grid to freeze particular columns at the time of scrolling.

Declaration

public ScrollOptionsBuilder<T> FrozenColumns(int columnCount)

Parameters

Type	Name	Description
System.Int32	columnCount	It accepts the integer value and freeze particular column based on the value

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

FrozenRows(Int32)

This specify the grid to freeze particular rows at the time of scrolling.

Declaration

public ScrollOptionsBuilder<T> FrozenRows(int rowCount)

Parameters

Type	Name	Description
System.Int32	rowCount	It accepts the integer value and freeze particular row based on the value

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

Height(Object)

This specify the grid to show the vertical scroll bar, to scroll and view the grid contents.

Declaration

public ScrollOptionsBuilder<T> Height(object height)

Parameters

Type	Name	Description
System.Object	height	It displays the height of vertical scrollbar based on the object value passed.

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

ScrollerSize(Int32)

If the scrollbar has vertical it set as width, else it will set as height of the handler.

Declaration

public ScrollOptionsBuilder<T> ScrollerSize(int scrollerSize)

Parameters

Type	Name	Description
System.Int32	scrollerSize	It accepts the integer value and sets the width and height of scrollbar

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

ScrollOneStepBy(Int32)

This specify the scroll down pixel of mouse wheel, to scroll mouse wheel and view the grid contents.

Declaration

public ScrollOptionsBuilder<T> ScrollOneStepBy(int step)

Parameters

Type	Name	Description
System.Int32	step	It accepts the integer value and scroll mouse wheel based on that value

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

VirtualScrollMode(VirtualScrollMode)

This is used to define the mode of virtual scrolling in grid.

Declaration

public ScrollOptionsBuilder<T> VirtualScrollMode(VirtualScrollMode scrollMode)

Parameters

Type	Name	Description
VirtualScrollMode	scrollMode	It displays the list of ScrollSettings option

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder

Width(Object)

This specify the grid to show the horizontal scroll bar, to scroll and view the grid contents

Declaration

public ScrollOptionsBuilder<T> Width(object width)

Parameters

Type	Name	Description
System.Object	width	It sets the width of horizontal scroll bar based on object value passed

Returns

Type	Description
ScrollOptionsBuilder<T>	ScrollOptionsBuilder