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

GridGroupsChangingEventArgs

Class

Holds properties specific for grouping mechanism such as performed action and reference to GridTableView where the action was performed.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

public class GridGroupsChangingEventArgs : EventArgs

Inheritance: objectEventArgsGridGroupsChangingEventArgs

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

Constructors

GridGroupsChangingEventArgs(GridTableView, GridGroupByExpression, GridGroupByExpression, GridGroupsChangingAction)

public GridGroupsChangingEventArgs(GridTableView tableView, GridGroupByExpression expression1, GridGroupByExpression expression2, GridGroupsChangingAction action)

Parameters:tableViewGridTableViewexpression1GridGroupByExpressionexpression2GridGroupByExpressionactionGridGroupsChangingAction

GridGroupsChangingEventArgs(GridTableView, GridGroupByExpression, GridGroupByField)

public GridGroupsChangingEventArgs(GridTableView tableView, GridGroupByExpression expression, GridGroupByField sortedField)

Parameters:tableViewGridTableViewexpressionGridGroupByExpressionsortedFieldGridGroupByField

GridGroupsChangingEventArgs(GridTableView, GridGroupByExpression, GridGroupsChangingAction)

public GridGroupsChangingEventArgs(GridTableView tableView, GridGroupByExpression expression, GridGroupsChangingAction action)

Parameters:tableViewGridTableViewexpressionGridGroupByExpressionactionGridGroupsChangingAction

Properties

Action

GridGroupsChangingAction

Gets a reference to GridGroupsChangingAction enumeration, which holds information about what action did fire the GroupsChanging event.

public GridGroupsChangingAction Action { get; }

Example:

<p>protected void RadGrid1_GroupsChanging(object source,
Telerik.Web.UI.GridGroupsChangingEventArgs e)<br />
{<br />
if (e.Action == GridGroupsChangingAction.Group)</p>
<p>{ ... }</p>

Canceled

bool

Gets or sets a value indicating whether GroupsChanging event will be canceled.

public bool Canceled { get; set; }

Property Value:

true, if the event is canceled, otherwise false.

Expression

GridGroupByExpression

Gets or sets the GridGroupByExpression that will be used for grouping Telerik RadGrid.

public GridGroupByExpression Expression { get; set; }

Example:

cs-api-definition
protected void RadGrid1_GroupsChanging(object source, Telerik.Web.UI.GridGroupsChangingEventArgs e)
{
if (e.Action == GridGroupsChangingAction.Group)
{
GridGroupByField countryGroupField = new GridGroupByField();
countryGroupField.FieldName = "Country";
GridGroupByField cityGroupField = new GridGroupByField();
cityGroupField.FieldName = "City";

e.Expression.SelectFields.Clear();
e.Expression.SelectFields.Add(countryGroupField);
e.Expression.SelectFields.Add(cityGroupField);

e.Expression.GroupByFields.Clear();
e.Expression.GroupByFields.Add(countryGroupField);
e.Expression.GroupByFields.Add(cityGroupField);
...
}
}
cs-api-definition.skip-repl
Protected Sub RadGrid1_GroupsChanging(ByVal source As Object, ByVal e As Telerik.Web.UI.GridGroupsChangingEventArgs)
'Expression is added (by drag/grop on group panel)
If (e.Action = GridGroupsChangingAction.Group) Then
Dim countryGroupField As GridGroupByField = New GridGroupByField
countryGroupField.FieldName = "Country"
Dim cityGroupField As GridGroupByField = New GridGroupByField
cityGroupField.FieldName = "City"
e.Expression.SelectFields.Clear
e.Expression.SelectFields.Add(countryGroupField)
e.Expression.SelectFields.Add(cityGroupField)
e.Expression.GroupByFields.Clear
e.Expression.GroupByFields.Add(countryGroupField)
e.Expression.GroupByFields.Add(cityGroupField)
End If
End Sub

SortedField

GridGroupByField

Gets a reference to the currently used GridGroupByField.

public GridGroupByField SortedField { get; }

SwapExpression

GridGroupByExpression

Gets the swap expression which represents the GridGroupByExpression with which the Expression will be swapped. The only case the value is not null is when Action property is set to Swap.

public GridGroupByExpression SwapExpression { get; }

Property Value:

The swap expression which represents the GridGroupByExpression with which the Expression will be swapped. The only case the value is not null is when Action property is set to Swap.

TableView

GridTableView

Gets a reference to the GridTableView object where the grouping is performed.

public GridTableView TableView { get; }

Property Value:

a reference to GridTableView object.