This documentation is archived and is not being maintained.

Wizard.OnActiveStepChanged Method

Raises the ActiveStepChanged event.

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

'Declaration
Protected Overridable Sub OnActiveStepChanged ( _
	source As Object, _
	e As EventArgs _
)
'Usage
Dim source As Object 
Dim e As EventArgs 

Me.OnActiveStepChanged(source, e)

Parameters

source
Type: System.Object

The source of the event.

e
Type: System.EventArgs

An EventArgs that contains the event data.

The OnActiveStepChanged method raises the ActiveStepChanged event when the ActiveStep property of the Wizard control is changed. Use the ActiveStepChanged event to provide additional processing when the current step that is displayed in the Wizard control changes.

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

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

The following code example demonstrates how to use the ActiveStepChanged event to update the HeaderText property of the Wizard control.

<%@ 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 OnActiveStepChanged(ByVal sender As Object, ByVal e As System.EventArgs)

    ' Every time that the ActiveStep property changes, change the HeaderText to match it.
    Wizard1.HeaderText = "You are currently on " + Wizard1.ActiveStep.Title

  End Sub

</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" 
          OnActiveStepChanged="OnActiveStepChanged" 
          HeaderText="ActiveStepChanged Example">
          <WizardSteps>
            <asp:WizardStep ID="WizardStep1" Title="Step 1" 
              Runat="server">
            </asp:WizardStep>
            <asp:WizardStep ID="WizardStep2" Title="Step 2" 
              Runat="server">
            </asp:WizardStep>
          </WizardSteps>
        </asp:Wizard>
      </form>
  </body>
</html>

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
Show: