New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

GridScrolling

Class

Contains properties related to customizing the settings for scrolling operation in Telerik RadGrid.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

[TypeConverter(typeof(ExpandableObjectConverter))]
public class GridScrolling : ObjectWithState

Inheritance: objectObjectWithStateGridScrolling

Inherited Members object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

GridScrolling(StateBag, RadGrid)

public GridScrolling(StateBag OwnerStateBag, RadGrid ownerGrid)

Parameters:OwnerStateBagStateBagownerGridRadGrid

Properties

AJAXScrollTop

string

Gets or sets the AJAX vertical scroll position of the grid.

[Browsable(false)]
public virtual string AJAXScrollTop { get; set; }

AllowScroll

bool

Gets or sets a value indicating whether scrolling will be enabled in Telerik RadGrid.

public virtual bool AllowScroll { get; set; }

Property Value:

true, if scrolling is enabled, otherwise false (the default value).

CountGroupSplitterColumnAsFrozen

bool

Gets or sets a value indicating if the GridGroupSplitterColumn will be part of the frozen columns count in grid

public virtual bool CountGroupSplitterColumnAsFrozen { get; set; }

Property Value:

true, if the GridGroupAplitterColumn will be part of the frozen columns count, otherwise false. The default value is true.

EnableColumnClientFreeze

bool

public virtual bool EnableColumnClientFreeze { get; set; }

EnableNextPrevFrozenColumns

bool

public virtual bool EnableNextPrevFrozenColumns { get; set; }

EnableVirtualScrollPaging

bool

Gets or sets a value indicating whether Telerik RadGrid will change the pages when you scroll using the grid scroller. This in terms of Telerik RadGrid is called Virtual Scrolling.

public virtual bool EnableVirtualScrollPaging { get; set; }

Property Value:

true, if virtual scrolling is enabled, otherwise false (the default value).

This property is particularly useful when working with huge datasets. Using the grid scrollbar, you can change the grid pages just like in Microsoft Word®. When scrolling with the virtual scrollbar, Telerik RadGrid uses AJAX requests to change the pages, i.e. no Postbacks are performed. The overall behavior is smooth and with no flicker.

Note that you should have AJAX enabled for Telerik RadGrid by setting the EnableAJAX="True".

To enable static columns, set the ClientSettings.Scrolling.FrozenColumnsCount property to a value greater than 0. The value of FrozenColumnsCount specifies the number of columns (starting with the leftmost column) that do not scroll when the of the user scrolls the grid horizontally, using the horizontal scroll bar. This feature is functional even when in hierarchical grids and grids that support grouping.

public virtual int FrozenColumnsCount { get; set; }

Property Value:

The frozen columns count.

SaveScrollPosition

bool

Gets or sets a value indicating whether Telerik RadGrid will keep the scroll position during postbacks.

public virtual bool SaveScrollPosition { get; set; }

Property Value:

true (the default value), if Telerik RadGrid keeps the scroll position on postback, otherwise false .

This property is meaningful only when used in conjunction with AllowScroll set to true.

ScrollBarWidth

Unit

Gets or sets the width of the scrollbar for the grid.

[Browsable(false)]
public virtual Unit ScrollBarWidth { get; set; }

ScrollHeight

Unit

Gets or sets a value specifying the grid height in pixels (px) beyond which the scrolling will be enabled.

public virtual Unit ScrollHeight { get; set; }

Property Value:

the default value is 300px

ScrollLeft

string

Gets or sets the horizontal scroll position of the grid.

[Browsable(false)]
public virtual string ScrollLeft { get; set; }

ScrollTop

string

Gets or sets the vertical scroll position of the grid.

[Browsable(false)]
public virtual string ScrollTop { get; set; }

UseStaticHeaders

bool

Gets or sets a value indicating whether grid column headers will scroll as the rest of the grid items or will remain static (MS Excel ® style).

public virtual bool UseStaticHeaders { get; set; }

Property Value:

true if headers remain static on scroll, otherwise false (the default value).

This property is meaningful only when used in conjunction with AllowScroll set to true.