Wizard.GetStepType(WizardStepBase, Int32) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the WizardStepType value for the specified WizardStepBase object.

public:
 System::Web::UI::WebControls::WizardStepType GetStepType(System::Web::UI::WebControls::WizardStepBase ^ wizardStep, int index);

public System.Web.UI.WebControls.WizardStepType GetStepType(System.Web.UI.WebControls.WizardStepBase wizardStep, int index);

member this.GetStepType : System.Web.UI.WebControls.WizardStepBase * int -> System.Web.UI.WebControls.WizardStepType

Public Function GetStepType (wizardStep As WizardStepBase, index As Integer) As WizardStepType

Parameters

wizardStep: WizardStepBase

The WizardStepBase for which the associated WizardStepType is returned.

index: Int32

The index of the WizardStepBase for which the associated WizardStepType is returned.

Returns

WizardStepType

One of the WizardStepType values.

Examples

The following code example demonstrates how to use the GetStepType method to determine the associated WizardStepType value for the current step of the Wizard control. Each time the ActiveStepChanged event is raised, the new WizardStepType value is retrieved and a message is written to Label1.

<%@ 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)
  { 
    Label tempLabel = (Label)Wizard1.FindControl("Label1");
    if (tempLabel != null)
    {
      // Get the step type of the ActiveStep and write it to Label1.
      WizardStepType tempStepType = Wizard1.GetStepType(Wizard1.ActiveStep, Wizard1.ActiveStepIndex);
      tempLabel.Text = "The current step type is " + tempStepType.ToString() + ".";
    }   
  }
  
</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">
          <WizardSteps>
            <asp:WizardStep id="WizardStep1" 
              title="Step 1" 
              runat="server">
            </asp:WizardStep>
            <asp:WizardStep id="WizardStep2" 
              title="Step 2" 
              runat="server">
            </asp:WizardStep>
            <asp:WizardStep id="WizardStep3" 
              runat="server" 
              title="Step 3">
            </asp:WizardStep>
          </WizardSteps>
          <HeaderTemplate>
            <b>GetStepType Example</b>
             <br />
            <asp:Label id="Label1" 
              runat="server" 
              width="208px" 
              height="19px">
            </asp:Label>
          </HeaderTemplate>
        </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 EventArgs)
    
    Dim tempLabel As Label = CType(Wizard1.FindControl("Label1"), Label)
    If Not tempLabel Is Nothing Then

      ' Get the step type of the ActiveStep and write it to Label1.
      Dim tempStepType As WizardStepType = Wizard1.GetStepType(Wizard1.ActiveStep, Wizard1.ActiveStepIndex)
      tempLabel.Text = "The current step type is " & tempStepType.ToString() & "."
 
    End If
 
  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">
          <WizardSteps>
            <asp:WizardStep id="WizardStep1" 
              title="Step 1" 
              runat="server">
            </asp:WizardStep>
            <asp:WizardStep id="WizardStep2" 
              title="Step 2" 
              runat="server">
            </asp:WizardStep>
            <asp:WizardStep id="WizardStep3" 
              runat="server" 
              title="Step 3">
            </asp:WizardStep>
          </WizardSteps>
          <HeaderTemplate>
            <b>GetStepType Example</b>
             <br />
            <asp:Label id="Label1" 
              runat="server" 
              width="208px" 
              height="19px">
            </asp:Label>
          </HeaderTemplate>
        </asp:Wizard>
      </form>
  </body>
</html>

Remarks

Use the GetStepType method to determine the WizardStepType value of the specified WizardStepBase object.

Applies to

Product	Versions
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via