Edit

Wizard.OnActiveStepChanged(Object, EventArgs) Method

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

Raises the ActiveStepChanged event.

protected:
 virtual void OnActiveStepChanged(System::Object ^ source, EventArgs ^ e);
protected virtual void OnActiveStepChanged (object source, EventArgs e);
abstract member OnActiveStepChanged : obj * EventArgs -> unit
override this.OnActiveStepChanged : obj * EventArgs -> unit
Protected Overridable Sub OnActiveStepChanged (source As Object, e As EventArgs)

Parameters

source
Object

The source of the event.

e
EventArgs

An EventArgs that contains the event data.

Examples

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>

<%@ 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>

Remarks

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 Handling and Raising Events.

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

Applies to

See also