This documentation is archived and is not being maintained.

Button::OnCommand Method

Raises the Command event of the Button control.

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

protected:
virtual void OnCommand(
	CommandEventArgs^ e
)

Parameters

e
Type: System.Web.UI.WebControls::CommandEventArgs

The event data.

The Command event is raised when the Button control is clicked. This event is commonly used when a command name, such as Sort, is associated with the Button control. This allows you to create multiple Button controls on a Web page and programmatically determine which Button control is clicked.

NoteNote:

The Command event is raised through the control hierarchy in the form of the BubbleEvent.

Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

The OnCommand method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors:

When overriding OnCommand in a derived class, be sure to call the base class's OnCommand method so that registered delegates receive the event.

The following code example demonstrates how to specify and code an event handler for the Command event to sort a list when the Button control is clicked. 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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

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