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)

protected virtual void OnActiveStepChanged(
	Object source,
	EventArgs 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="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 OnActiveStepChanged(object sender, EventArgs e)
  {
    // Every time that the ActiveStep property changes, change the HeaderText to match it.
    Wizard1.HeaderText = "You are currently on " + Wizard1.ActiveStep.Title;
  }

</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 Title="Step 1" 
              Runat="server">
            </asp:WizardStep>
            <asp:WizardStep Title="Step 2" 
              Runat="server">
            </asp:WizardStep>
          </WizardSteps>
        </asp:Wizard>
      </form>
  </body>
</html>


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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