CommandEventArgs Class

.NET Framework (current version)

Provides data for the Command event.

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

Inheritance Hierarchy

Syntax

C++

type CommandEventArgs = 
    class
        inherit EventArgs
    end

Constructors

	Name	Description
	CommandEventArgs(CommandEventArgs)	Initializes a new instance of the CommandEventArgs class with another CommandEventArgs object.
	CommandEventArgs(String, Object)	Initializes a new instance of the CommandEventArgs class with the specified command name and argument.

Properties

	Name	Description
	CommandArgument	Gets the argument for the command.
	CommandName	Gets the name of the command.

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 Command event is raised when a Button or ImageButton control is clicked.

The CommandEventArgs object contains data about the Command event that can be accessed in the event handler. Using the properties available in the CommandEventArgs class, you can determine the name of the command to perform, such as Sort, in addition to an optional argument that supplements the command, such as Ascending.

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

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

Examples

The following example demonstrates how to access the properties in CommandEventArgs to determine the command to perform. This example specifies the event handler declaratively, using the OnClick property of the Button control.

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

The following code example demonstrates how to specify the event handler and programmatically add it to the event in the Page_Load method.

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

Version Information

.NET Framework
Available since 1.1

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.