Modifier

Wizard.FinishNavigationTemplate Property

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

Gets or sets the template that is used to display the navigation area on the Finish step.

public:
 virtual property System::Web::UI::ITemplate ^ FinishNavigationTemplate { 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 FinishNavigationTemplate { 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.FinishNavigationTemplate : System.Web.UI.ITemplate with get, set
Public Overridable Property FinishNavigationTemplate As ITemplate

Property Value

ITemplate

The ITemplate that defines the content for the navigation area for the Finish on the Wizard. The default is null.

Attributes
BrowsableAttribute PersistenceModeAttribute TemplateContainerAttribute

Examples

The following code example demonstrates how to use the FinishNavigationTemplate property to create a custom template for the navigation area of the Finish step for the Wizard control.

Important

This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

<%@ 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 OnFinishButtonClick(object sender, EventArgs e)
  {
    // Insert code here that determines if an email address was
    // entered in emailTextBox. Then send an confirmation email if it was.     
  }
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" 
      title="FinishNavigationTemplate Example" 
      runat="server">
      <asp:Wizard ID="Wizard1" 
        Runat="server" 
        ActiveStepIndex="0" 
        OnFinishButtonClick="OnFinishButtonClick">
        <WizardSteps>
          <asp:WizardStep Runat="server" 
            Title="Step 1">
            <!-- Put UI elements for Step 1 here. -->
            This is step one.
          </asp:WizardStep>
          <asp:WizardStep Runat="server" 
            Title="Step 2">
            <!-- Put UI elements for Step 2 here. -->
            This is step two.
          </asp:WizardStep>
          <asp:WizardStep Runat="server" 
            StepType="Complete" 
            Title="Complete">
            The Wizard has been completed.
          </asp:WizardStep>
        </WizardSteps>
        <FinishNavigationTemplate>
          Please enter your email address if you would like a confirmation email:
          <asp:TextBox ID="emailTextBox" 
            Runat="server">
          </asp:TextBox>
           <br />
          <asp:Button CommandName="MovePrevious"
              Runat="server" 
              Text="Previous" />
          <asp:Button CommandName="MoveComplete" 
            Runat="server" 
            Text="Finish" />
        </FinishNavigationTemplate>
        <HeaderTemplate>
          <b>FinishNavigationTemplate Example</b>
        </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 OnFinishButtonClick(ByVal sender As Object, ByVal e As WizardNavigationEventArgs)
    ' Insert code here that determines if an email address was
    ' entered in emailTextBox. Then send an confirmation email if it was.     
  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" 
      title="FinishNavigationTemplate Example" 
      runat="server">
      <asp:Wizard ID="Wizard1" 
        Runat="server" 
        ActiveStepIndex="0" 
        OnFinishButtonClick="OnFinishButtonClick">
        <WizardSteps>
          <asp:WizardStep Runat="server" 
            Title="Step 1">
            <!-- Put UI elements for Step 1 here. -->
            This is step one.
          </asp:WizardStep>
          <asp:WizardStep Runat="server" 
            Title="Step 2">
            <!-- Put UI elements for Step 2 here. -->
            This is step two.
          </asp:WizardStep>
          <asp:WizardStep Runat="server" 
            StepType="Complete" 
            Title="Complete">
            The Wizard has been completed.
          </asp:WizardStep>
        </WizardSteps>
        <FinishNavigationTemplate>
          Please enter your email address if you would like a confirmation email:
          <asp:TextBox ID="emailTextBox" 
            Runat="server">
          </asp:TextBox>
           <br />
          <asp:Button CommandName="MovePrevious"
              Runat="server" 
              Text="Previous" />
          <asp:Button CommandName="MoveComplete" 
            Runat="server" 
            Text="Finish" />
        </FinishNavigationTemplate>
        <HeaderTemplate>
          <b>FinishNavigationTemplate Example</b>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>

Remarks

Use the FinishNavigationTemplate property to specify the custom content that is displayed for the navigation area on the Finish step of the Wizard control. Define the content by creating a template that specifies how the navigation area is rendered on the Finish step.

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

Note

The FinishNavigationTemplate object that is contained in the FinishNavigationTemplate property must contain two IButtonControl controls, one with its CommandName property set to "MoveComplete" and the other with its CommandName property set to "MovePrevious", to enable the navigation feature.

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

See also