Export (0) Print
Expand All
Expand Minimize

Wizard.SideBarTemplate Property

Gets or sets the template that is used to display the sidebar area on the control.

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

[TemplateContainerAttribute(typeof(Wizard))]
[BrowsableAttribute(false)]
[PersistenceModeAttribute(PersistenceMode.InnerProperty)]
public virtual ITemplate SideBarTemplate { get; set; }
<asp:Wizard>
	<SideBarTemplate>ITemplate</SideBarTemplate>
</asp:Wizard>

Property Value

Type: System.Web.UI.ITemplate
An ITemplate that contains the template for displaying the sidebar area on the Wizard. The default is null.

Use the SideBarTemplate property to specify the custom content that is displayed for the sidebar area on a Wizard control. Define the content by creating a template that specifies how the sidebar area is rendered.

The custom content for the template is contained within the SideBarTemplate object. You can add custom content to the SideBarTemplate object either by using template-editing mode in design view or by defining the SideBarTemplate object inline using SideBarTemplate tags. The content can be as simple as plain text or more complex (embedding other controls in the template, for example).

NoteNote

The SideBarTemplate object must contain a DataList control or ListView control whose ID property is set to "SideBarList" to enable the sidebar navigation feature. Also, the "SideBarList" on the DataList or ListView control must contain an IButtonControl control.

To access a control that is defined in a template programmatically, use the Controls collection of the Wizard object. You can also use the FindControl method of the Wizard object to find the control, if the control has an ID property specified.

The following example shows how to add a ListView control to the SideBarTemplate element and how to use a LinkButton control to navigate the steps.

<SideBarTemplate>
  <asp:ListView ID="sideBarList" runat="server">
    <LayoutTemplate>
    <div id="ItemPlaceHolder" runat="server"/>
    </LayoutTemplate>

    <ItemTemplate>
      <asp:LinkButton ID="sideBarButton" runat="server" 
          Text="Button" />
    </ItemTemplate>
  </asp:ListView>
</SideBarTemplate>

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft