Wizard.SideBarButtonClick Event (System.Web.UI.WebControls)

Switch View

SideBarButtonClick Event

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Wizard..::.SideBarButtonClick Event

Occurs when a button in the sidebar area is clicked.

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

Syntax

Visual Basic (Declaration)

Public Overridable Event SideBarButtonClick As WizardNavigationEventHandler

Visual Basic (Usage)

Dim instance As Wizard
Dim handler As WizardNavigationEventHandler

AddHandler instance.SideBarButtonClick, handler

public virtual event WizardNavigationEventHandler SideBarButtonClick

Visual C++

public:
virtual  event WizardNavigationEventHandler^ SideBarButtonClick {
    void add (WizardNavigationEventHandler^ value);
    void remove (WizardNavigationEventHandler^ value);
}

JScript

JScript does not support events.

ASP.NET

<asp:Wizard OnSideBarButtonClick="WizardNavigationEventHandler" />

Remarks

The SideBarButtonClick event is raised when a button in the sidebar area on the Wizard control is clicked. Use the SideBarButtonClick event to provide additional processing when a button in the sidebar area is clicked.

Note:
The SideBarButtonClick event does not raise an event if a Button control with the CommandName property set to Move is outside of the DataList control's sidebar list for the SideBarTemplate object.

For more information about handling events, see Consuming Events.

Examples

The following code example demonstrates how to specify an event handler for the SideBarButtonClick event. Each time the SideBarButtonClick event is raised, a message is written to the Text property for Label1 with information on which sidebar area button was clicked.

Visual Basic

<%@ 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 OnSideBarButtonClick(ByVal sender As Object, ByVal e As WizardNavigationEventArgs)
    ' When a button in the sidebar area is clicked, put a message
    ' in Label1 to be displayed in the header area.
    Dim tempLabel As Label = CType(Wizard1.FindControl("Label1"), Label)
    If Not tempLabel Is Nothing Then
      tempLabel.Text = "You clicked the button for Step " & _
        (e.NextStepIndex + 1) & "."
    End If
  End Sub

</script>

<html  >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:Wizard id="Wizard1" 
        runat="server" 
        onsidebarbuttonclick="OnSideBarButtonClick">
        <WizardSteps>
          <asp:WizardStep id="WizardStep1" 
            runat="server" 
            title="Step 1">
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep2" 
            runat="server" 
            title="Step 2">
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep3" 
            runat="server" 
            title="Step 3">
          </asp:WizardStep>
        </WizardSteps>
        <HeaderTemplate>
          <b>SideBarButtonClick Example</b>
          &nbsp;<br />
          <asp:Label id="Label1" 
            runat="server" 
            width="208px" 
            height="19px">
          </asp:Label>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>

<%@ 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 OnSideBarButtonClick(object sender, WizardNavigationEventArgs e)
  {
    // When a button in the sidebar area is clicked, put a message
    // in Label1 to be displayed in the header area.
    Label tempLabel = (Label)Wizard1.FindControl("Label1");
    if (tempLabel != null)
    {
      tempLabel.Text = "You clicked the button for Step " + 
        (e.NextStepIndex + 1) + ".";
    }
  }

</script>

<html  >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:Wizard id="Wizard1" 
        runat="server" 
        onsidebarbuttonclick="OnSideBarButtonClick">
        <WizardSteps>
          <asp:WizardStep id="WizardStep1" 
            runat="server" 
            title="Step 1">
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep2" 
            runat="server" 
            title="Step 2">
          </asp:WizardStep>
          <asp:WizardStep id="WizardStep3" 
            runat="server" 
            title="Step 3">
          </asp:WizardStep>
        </WizardSteps>
        <HeaderTemplate>
          <b>SideBarButtonClick Example</b>
          &nbsp;<br />
          <asp:Label id="Label1" 
            runat="server" 
            width="208px" 
            height="19px">
          </asp:Label>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>

Platforms

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

Wizard Class

Wizard Members

System.Web.UI.WebControls Namespace

OnSideBarButtonClick

Other Resources

Wizard Web Server Control Overview