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

GridCommandEventArgs

Class

Provides data for Command events including CancelCommand, DeleteCommand, EditCommand, InsertCommand, ItemCommand, SortCommand and UpdateCommand.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

public class GridCommandEventArgs : CommandEventArgs, IGridCommandEvent

Inheritance: objectEventArgsCommandEventArgsGridCommandEventArgs

Derived Classes: GridClearFilterCommandEventArgsGridClearSortCommandEventArgsGridExpandCollapseAllEventArgsGridGroupsCustomExpandCollapseGridGroupsExpandAllEventArgsGridHeaderContextMenuFilterEventArgsGridPageChangedEventArgsGridPageSizeChangedEventArgsGridSortCommandEventArgs...

Implements: IGridCommandEvent

Inherited Members CommandEventArgs.CommandNameCommandEventArgs.CommandArgumentEventArgs.Emptyobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

GridCommandEventArgs(GridItem, object, CommandEventArgs)

public GridCommandEventArgs(GridItem item, object commandSource, CommandEventArgs originalArgs)

Parameters:itemGridItemcommandSourceobjectoriginalArgsCommandEventArgs

Properties

Canceled

bool

Gets or sets a value, defining whether the command should be canceled.

public bool Canceled { get; set; }

Implements: IGridCommandEvent.Canceled

Example:

cs-api-definition
protected void RadGrid1_UpdateCommand(object source, GridCommandEventArgs e)
{
if (e.Item is GridEditFormItem &amp;&amp; e.Item.IsInEditMode)
{
GridEditFormItem item = e.Item as GridEditFormItem;
Hashtable newValues = new Hashtable();
item.OwnerTableView.ExtractValuesFromItem(newValues, item);
if (newValues["Name"].ToString() == "DefaultName")
{
e.Canceled = true;
}
}
}
cs-api-definition.skip-repl
Protected Sub RadGrid1_UpdateCommand([source] As Object, e As GridCommandEventArgs)
If Typeof e.Item Is GridEditFormItem AndAlso e.Item.IsInEditMode Then
Dim item As GridEditFormItem = e.Item
Dim newValues As New Hashtable()
item.OwnerTableView.ExtractValuesFromItem(newValues, item)
If newValues("Name").ToString() = "DefaultName" Then
e.Canceled = True
End If
End If
End Sub

CommandSource

object

Gets the source of the command

public object CommandSource { get; }

Example:

cs-api-definition
// Get a reference to the control that triggered expand/collapse command
protected void RadGrid1_ItemCommand(object source, GridCommandEventArgs e)
{
if (e.CommandName == RadGrid.ExpandCollapseCommandName)
{
Control c = e.CommandSource as Control;
}
}
cs-api-definition.skip-repl
' Get a reference to the control that triggered expand/collapse command
Protected Sub RadGrid1_ItemCommand([source] As Object, e As GridCommandEventArgs)
If e.CommandName = RadGrid.ExpandCollapseCommandName Then
Dim c As Control = e.CommandSource
End If
End Sub 'RadGrid1_ItemCommand

Item

GridItem

Gets the item containing the command source

public GridItem Item { get; }

Example:

cs-api-definition
protected void RadGrid1_UpdateCommand(object source, GridCommandEventArgs e)
{
if (e.Item is GridEditFormItem &amp;&amp; e.Item.IsInEditMode)
{
GridEditFormItem item = e.Item as GridEditFormItem;
Hashtable newValues = new Hashtable();
item.OwnerTableView.ExtractValuesFromItem(newValues, item);
if (newValues["Name"].ToString() == "DefaultName")
{
e.Canceled = true;
}
}
}
cs-api-definition.skip-repl
Protected Sub RadGrid1_UpdateCommand([source] As Object, e As GridCommandEventArgs)
If Typeof e.Item Is GridEditFormItem AndAlso e.Item.IsInEditMode Then
Dim item As GridEditFormItem = e.Item
Dim newValues As New Hashtable()
item.OwnerTableView.ExtractValuesFromItem(newValues, item)
If newValues("Name").ToString() = "DefaultName" Then
e.Canceled = True
End If
End If
End Sub

Methods

ExecuteCommand(object)

Fires the command stored in CommandName property

[SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily")]
public virtual void ExecuteCommand(object source)

Parameters:sourceobject

Implements: IGridCommandEvent.ExecuteCommand(object)

SetCommandSource(object)

protected void SetCommandSource(object commandSource)

Parameters:commandSourceobject