Wizard.OnFinishButtonClick Method (WizardNavigationEventArgs)

 

Raises the FinishButtonClick event.

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

protected virtual void OnFinishButtonClick(
	WizardNavigationEventArgs e
)

The FinishButtonClick event is raised when the Finish button is clicked.

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

The OnFinishButtonClick 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 OnFinishButtonClick method in a derived class, be sure to call the OnFinishButtonClick 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 FinishButtonClick event. When the Finish button is clicked, a confirmation message is written to Label1 and the Label1.Visible property is set to true so that the message is displayed on the step.

<%@ 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 OnFinishButtonClick(object sender, WizardNavigationEventArgs e)
  {
    // When the Finish button is clicked, write a confirmation
    // that the wizard was completed to Label1, and make it visible.
    Label1.Text = "The wizard has been completed.";
    Label1.Visible = true;
  }

</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" 
        onfinishbuttonclick="OnFinishButtonClick">
        <WizardSteps>
          <asp:WizardStep id="WizardStep1" 
            title="Step 1" 
            runat="server">
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep2" 
            title="Step 2" 
            runat="server">
          </asp:WizardStep>
        </WizardSteps>
        <HeaderTemplate>
          <b>FinishButtonClick Example</b>
        </HeaderTemplate>
      </asp:Wizard>
      <asp:Label id="Label1" 
        runat="Server" 
        visible="False" />
    </form>
  </body>
</html>

.NET Framework
Available since 2.0
Return to top
Show: