OnCancelButtonClick Method

Wizard.OnCancelButtonClick Method (EventArgs)

 

Raises the CancelButtonClick event.

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

protected virtual void OnCancelButtonClick(
	EventArgs e
)

Parameters

e
Type: System.EventArgs

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 NIB: 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="C#" %>

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

<script runat="server">

  void OnCancelButtonClick(object sender, EventArgs e)
  {
    // When the Cancel button is clicked, redirect to http://www.wingtiptoys.com/.
    Response.Redirect("http://www.wingtiptoys.com/");
  }

</script>

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

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft