Wizard.OnSideBarButtonClick Method (WizardNavigationEventArgs)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Raises the SideBarButtonClick event.

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

protected virtual void OnSideBarButtonClick(
	WizardNavigationEventArgs e
)

The SideBarButtonClick event is raised when a button on the sidebar area is clicked.

System_CAPS_noteNote

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.

Raising an event invokes the event handler through a delegate. For more information, see NIB: Raising an Event.

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

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.

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

.NET Framework
Available since 2.0
Return to top
Show: