Wizard.SideBarButtonClick Event

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.

Occurs when a button in the sidebar area is clicked.

public:
 virtual event System::Web::UI::WebControls::WizardNavigationEventHandler ^ SideBarButtonClick;

public virtual event System.Web.UI.WebControls.WizardNavigationEventHandler SideBarButtonClick;

member this.SideBarButtonClick : System.Web.UI.WebControls.WizardNavigationEventHandler

Public Overridable Custom Event SideBarButtonClick As WizardNavigationEventHandler

Event Type

WizardNavigationEventHandler

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.

ASP.NET (C#)

<%@ 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 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" 
        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>
           <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 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 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" 
        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>
           <br />
          <asp:Label id="Label1" 
            runat="server" 
            width="208px" 
            height="19px">
          </asp:Label>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>

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 how to handle events, see Handling and Raising Events.

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