Wizard.OnCancelButtonClick Method

Note: This method is new in the .NET Framework version 2.0.

Raises the CancelButtonClick event.

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

'Declaration
Protected Overridable Sub OnCancelButtonClick ( _
	e As EventArgs _
)
'Usage
Dim e As EventArgs

Me.OnCancelButtonClick(e)
protected void OnCancelButtonClick (
	EventArgs e
)
protected function OnCancelButtonClick (
	e : EventArgs
)

Parameters

e

An EventArgs containing the event data.

The CancelButtonClick event is raised when the Cancel button is clicked.

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

The OnCancelButtonClick 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 the OnCancelButtonClick method in a derived class, be sure to call the OnCancelButtonClick method of the base class so that registered delegates receive the event.

The following code example demonstrates how to specify an event handler for the CancelButtonClick event. When the Cancel button is clicked, the step is redirected to http://www.wingtiptoys.com/.

<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
  
  Sub OnCancelButtonClick(ByVal sender As Object, ByVal e As EventArgs)
    ' When the Cancel button is clicked, redirect to http://www.wingtiptoys.com/.
    Response.Redirect("http://www.wingtiptoys.com/")
  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <body>
    <form id="form1" runat="server">
      <asp:Wizard id="Wizard1" 
        runat="server" 
        displaycancelbutton="True"
        oncancelbuttonclick="OnCancelButtonClick">
        <HeaderTemplate>
          <b>CancelButtonClick Example</b>
        </HeaderTemplate>
        <WizardSteps>
          <asp:WizardStep title="Step 1" 
            runat="server">
          </asp:WizardStep>
          <asp:WizardStep title="Step 2" 
            runat="server">
          </asp:WizardStep>
        </WizardSteps>
      </asp:Wizard>
    </form>
  </body>
</html>

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: