This documentation is archived and is not being maintained.

CommandEventArgs Class

Provides data for the Command event.

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

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

public ref class CommandEventArgs : public EventArgs

The CommandEventArgs type exposes the following members.

  NameDescription
Public methodCommandEventArgs(CommandEventArgs)Initializes a new instance of the CommandEventArgs class with another CommandEventArgs object.
Public methodCommandEventArgs(String, Object)Initializes a new instance of the CommandEventArgs class with the specified command name and argument.
Top

  NameDescription
Public propertyCommandArgumentGets the argument for the command.
Public propertyCommandNameGets the name of the command.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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 Consuming Events.

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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

Show: