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

The class containing properties associated with the client-side functionlities of RadGrid.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

C#
[TypeConverter(typeof(ExpandableObjectConverter))]
public class GridClientSettings : ObjectWithState

Inheritance: objectObjectWithStateGridClientSettings

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

Constructors

C#
public GridClientSettings(StateBag OwnerStateBag, RadGrid owner)
Parameters:OwnerStateBagStateBagownerRadGrid

Properties

Gets or sets the index of the RadGrid active row.

C#
public string ActiveRowIndex { get; set; }
Property Value:

The index of the active row.

Gets or sets a value indicating whether MasterTableView will be automatically scrolled when an item is dragged.

C#
public virtual bool AllowAutoScrollOnDragDrop { get; set; }

Gets or sets the property determining if the RadGrid columns could be hidden.

C#
public virtual bool AllowColumnHide { get; set; }
Property Value:

The allow column hide.

Gets or sets a value indicating whether you will be able to reorder columns by using drag&drop. By default it is false.

C#
public virtual bool AllowColumnsReorder { get; set; }
Property Value:

true if reorder via drag&drop is enabled, otherwise false (the default value).

Gets or sets a value indicating whether you will be able to drag column headers to GridGroupPanel and let the grid automatically form GroupByExpression and group its data.

C#
public virtual bool AllowDragToGroup { get; set; }
Property Value:

true, if you are able to drag group header to the group panel, otherwise false (the default value)

Gets or sets a value indicating whether the expand/collapse functionality for hierarchical structures in grid will be enabled.

The AllowExpandCollapse property of RadGrid is meaningful with client hierarchy load mode only and determine
whether the end user will be able to expand/collapse grid items. This property do not control the visibility of the corresponding expand/collapse column.

C#
public virtual bool AllowExpandCollapse { get; set; }
Property Value:

true if expand/collapse is enabled, otherwise false (the default value).

This property should be set to true, when working in HierarchyLoadMode.Client.

Gets or sets a value indicating whether the expand/collapse functionality for grouped data in grid will be enabled.

The AllowGroupExpandCollapse property of RadGrid is meaningful with client group load mode only and determine whether the end user will be able to expand/collapse grid items. This property do not control the visibility of the corresponding expand/collapse column.

C#
public virtual bool AllowGroupExpandCollapse { get; set; }
Property Value:

true, if expand/collapse is enabled, otherwise false (the default value).

Gets or sets a value indicating whether the keyboard navigation will be enabled in Telerik RadGrid.

C#
public virtual bool AllowKeyboardNavigation { get; set; }
Property Value:

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

  • Arrowkey Navigation - allows end-users to navigate around the menu structure using the arrow keys.
  • select grid items pressing the [SPACE] key
  • edit rows hitting the [ENTER] key

Gets or sets a value which determines if the RadGrid rows could be hidden.

C#
public virtual bool AllowRowHide { get; set; }
Property Value:

The allow row hide.

Gets or sets the value determining if the rows could be dragged and dropped.

C#
public virtual bool AllowRowsDragDrop { get; set; }
Property Value:

The allow rows drag drop.

Gets a reference to GridAnimationSettings class providing properties related to client-side grid animations.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public GridAnimationSettings Animation { get; }

Gets a reference to GridClientEvents class.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public GridClientEvents ClientEvents { get; }

Gets a reference to GridClientMessages class, holding properties that can be used for localizing Telerik RadGrid.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public GridClientMessages ClientMessages { get; }

Gets or sets the columns reorder method determining behavior when reordering method.

C#
public virtual GridClientSettings.GridColumnsReorderMethod ColumnsReorderMethod { get; set; }
Property Value:

The columns reorder method.

Gets a reference to GridClientDataBinding class providing properties related to client-side data-binding settings.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public GridClientDataBinding DataBinding { get; }

Determines whether the alternating items will render with a different CSS class.

C#
public virtual bool EnableAlternatingItems { get; set; }

Gets or sets a value which determines whether the client print grid functionality will be enabled.

C#
public virtual bool EnableClientPrint { get; set; }
Property Value:

A value which determines whether the client print grid functionality will be enabled.

Gets or sets the value dermeming if a row click will trigger a postback.

C#
public virtual bool EnablePostBackOnRowClick { get; set; }
Property Value:

The enable post back on row click.

Gets or sets if a style is applied when a mouse is over a row.

C#
public virtual bool EnableRowHoverStyle { get; set; }
Property Value:

The enable row hover style.

Gets a reference to GridKeyboardNavigationSettings class, holding properties related to RadGrid keyboard navigation.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public GridKeyboardNavigationSettings KeyboardNavigationSettings { get; }

Gets or sets a value indicating whether columns will be reordered on the client. This property is meaningful when used in conjunction with AllowColumnsReorder set to true.

C#
public virtual bool ReorderColumnsOnClient { get; set; }
Property Value:

true if columns are reordered on the client, otherwise false (the default value.

False by default, which means that each time you try to reorder columns a postback will be performed.

Note that in case this property is true the order changes will be persisted on the server only after postback.

Gets a reference to GridResizing, which holds properties related to Telerik RadGrid resizing features.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public GridResizing Resizing { get; }

Gets a reference to GridScrolling, which holds various properties for setting the Telerik RadGrid scrolling features.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public GridScrolling Scrolling { get; }

Gets a reference to GridSelecting class providing properties related to client-side selection features.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public GridSelecting Selecting { get; }

Gets if the RadGrid client-side row objects will be created.

C#
[Browsable(false)]
public bool ShouldCreateRows { get; }

Gets a reference to the GridVirtualization which holds various properties for controling the Telerik RadGrid virtualization features.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public GridVirtualization Virtualization { get; }

Methods

Checks if a client settings property value was changed and differs from its default.

C#
public bool IsSet()
Returns:

bool

This method is for Telerik RadGrid internal usage.