GridViewCommandEventArgs Class

.NET Framework (current version)

Provides data for the RowCommand event.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)

Inheritance Hierarchy

System::Object
System::EventArgs
System.Web.UI.WebControls::CommandEventArgs
System.Web.UI.WebControls::GridViewCommandEventArgs

Syntax

C++

public ref class GridViewCommandEventArgs : CommandEventArgs

Constructors

	Name	Description
	GridViewCommandEventArgs(GridViewRow^, Object^, CommandEventArgs^)	Initializes a new instance of the GridViewCommandEventArgs class using the specified row, source of the command, and event arguments.
	GridViewCommandEventArgs(Object^, CommandEventArgs^)	Initializes a new instance of the GridViewCommandEventArgs class using the specified source of the command and event arguments.

Properties

	Name	Description
	CommandArgument	Gets the argument for the command.(Inherited from CommandEventArgs.)
	CommandName	Gets the name of the command.(Inherited from CommandEventArgs.)
	CommandSource	Gets the source of the command.
	Handled

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Remarks

The RowCommand event is raised when a button within the GridView control is clicked. This allows you to provide an event-handling method that performs a custom routine whenever this event occurs.

Note
The GridView control also raises other specialized events when certain buttons are clicked (buttons with the CommandName property set to "Delete", "Update", and "Page" for example). When using one of these buttons, you should consider handling one of the specialized events provided by the control (such as RowDeleted or RowDeleting).

A GridViewCommandEventArgs object is passed to the event-handling method, which allows you to determine the command name and command argument of the button clicked. To determine the command name and command argument, use the CommandName and CommandArgument properties, respectively. You can also access the button control that raised the event by using the CommandSource property.

For more information about handling events, see NIB: Consuming Events.

For a list of initial property values for an instance of GridViewCommandEventArgs, see the GridViewCommandEventArgs constructor.

Examples

The following example demonstrates how to use the GridViewCommandEventArgs object passed to the event-handling method to determine the command name of the button that raised the event.

C++

No code example is currently available or this language may not be supported.

Version Information

.NET Framework
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.