Wizard.SideBarTemplate Property

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.

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

public:
 virtual property System::Web::UI::ITemplate ^ SideBarTemplate { System::Web::UI::ITemplate ^ get(); void set(System::Web::UI::ITemplate ^ value); };

[System.ComponentModel.Browsable(false)]
[System.Web.UI.PersistenceMode(System.Web.UI.PersistenceMode.InnerProperty)]
[System.Web.UI.TemplateContainer(typeof(System.Web.UI.WebControls.Wizard))]
public virtual System.Web.UI.ITemplate SideBarTemplate { get; set; }

[<System.ComponentModel.Browsable(false)>]
[<System.Web.UI.PersistenceMode(System.Web.UI.PersistenceMode.InnerProperty)>]
[<System.Web.UI.TemplateContainer(typeof(System.Web.UI.WebControls.Wizard))>]
member this.SideBarTemplate : System.Web.UI.ITemplate with get, set

Public Overridable Property SideBarTemplate As ITemplate

Property Value

ITemplate

An ITemplate that contains the template for displaying the sidebar area on the Wizard. The default is null.

Attributes: BrowsableAttribute PersistenceModeAttribute TemplateContainerAttribute

Examples

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>

Remarks

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).

Note

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.

Applies to

Jaa