Wizard.FinishNavigationTemplate プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

Wizard.FinishNavigationTemplate プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

Finish ステップのナビゲーション領域を表示するために使用されるテンプレートを取得または設定します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

<TemplateContainerAttribute(GetType(Wizard))> _
Public Overridable Property
 FinishNavigationTemplate As ITemplate

Visual Basic (使用法)

Dim instance As Wizard
Dim value As ITemplate

value = instance.FinishNavigationTemplate

instance.FinishNavigationTemplate = value

[TemplateContainerAttribute(typeof(Wizard))] 
public virtual ITemplate FinishNavigationTemplate { get;
 set; }

C++

[TemplateContainerAttribute(typeof(Wizard))] 
public:
virtual property ITemplate^ FinishNavigationTemplate {
    ITemplate^ get ();
    void set (ITemplate^ value);
}

/** @property */
public ITemplate get_FinishNavigationTemplate ()

/** @property */
public void set_FinishNavigationTemplate (ITemplate
 value)

JScript

public function get FinishNavigationTemplate
 () : ITemplate

public function set FinishNavigationTemplate
 (value : ITemplate)

プロパティ値
Wizard の Finish のナビゲーション領域に表示されるコンテンツを定義する ITemplate。既定値は null 参照 (Visual Basic では Nothing) です。

解説

FinishNavigationTemplate プロパティを使用して、Wizard コントロールの Finish ステップのナビゲーション領域に表示されるカスタムコンテンツを指定します。Finish ステップにナビゲーション領域を表示する方法を指定するテンプレートを作成して、コンテンツを定義します。

テンプレートのカスタムコンテンツは、FinishNavigationTemplate オブジェクトに格納されます。FinishNavigationTemplate オブジェクトにカスタムコンテンツを追加するには、デザインビューでテンプレート編集モードを使用するか、または FinishNavigationTemplate タグを使用して FinishNavigationTemplate オブジェクトをインラインで定義します。内容は、簡単なプレーンテキストとしたり、テンプレートに他のコントロールを埋め込んで複雑にしたりできます。

メモ
FinishNavigationTemplate プロパティに格納された FinishNavigationTemplate オブジェクトは、2 つのIButtonControl コントロールを格納している必要があります。ナビゲーション機能を有効にするためには、一方のコントロールは CommandName プロパティが `"MoveFinish"` に設定され、もう一方のコントロールは CommandName プロパティが `"MovePrevious"` に設定されている必要があります。

メモ

FinishNavigationTemplate プロパティに格納された FinishNavigationTemplate オブジェクトは、2 つのIButtonControl コントロールを格納している必要があります。ナビゲーション機能を有効にするためには、一方のコントロールは CommandName プロパティが "MoveFinish" に設定され、もう一方のコントロールは CommandName プロパティが "MovePrevious" に設定されている必要があります。

テンプレートで定義されたコントロールにプログラムからアクセスするには、Wizard オブジェクトの Controls コレクションを使用します。コントロールに ID プロパティが指定されている場合は、Wizard オブジェクトの FindControl メソッドを使用してコントロールを検索することもできます。

使用例

FinishNavigationTemplate プロパティを使用して、Wizard コントロールの Finish ステップに表示されるナビゲーション領域のカスタムテンプレートを作成する方法を次のコード例に示します。

Visual Basic

<%@ 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  >
  <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>
          &nbsp;<br />
          <asp:Button CommandName="MovePrev"
              Runat="server" 
              Text="Previous" />
          <asp:Button CommandName="MoveFinish"
 
            Runat="server" 
            Text="Finish" />
        </FinishNavigationTemplate>
        <HeaderTemplate>
          <b>FinishNavigationTemplate Example</b>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>

<%@ 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  >
  <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>
          &nbsp;<br />
          <asp:Button CommandName="MovePrev"
              Runat="server" 
              Text="Previous" />
          <asp:Button CommandName="MoveFinish" 
            Runat="server" 
            Text="Finish" />
        </FinishNavigationTemplate>
        <HeaderTemplate>
          <b>FinishNavigationTemplate Example</b>
        </HeaderTemplate>
      </asp:Wizard>
    </form>
  </body>
</html>