Page.VerifyRenderingInServerForm メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引

Page.VerifyRenderingInServerForm メソッド

実行時に、指定された ASP.NET サーバーコントロールに HtmlForm コントロールが表示されることを確認します。

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

Visual Basic (宣言)

Public Overridable Sub VerifyRenderingInServerForm
 ( _
    control As Control _
)

Visual Basic (使用法)

Dim instance As Page
Dim control As Control

instance.VerifyRenderingInServerForm(control)

public virtual void VerifyRenderingInServerForm
 (
    Control control
)

C++

public:
virtual void VerifyRenderingInServerForm (
    Control^ control
)

public void VerifyRenderingInServerForm (
    Control control
)

JScript

public function VerifyRenderingInServerForm
 (
    control : Control
)

パラメータ

control: HtmlForm コントロール内に配置する必要がある ASP.NET サーバーコントロール。

例外

例外の種類	条件
HttpException	実行時に、指定されたサーバーコントロールが HtmlForm サーバーコントロールの開始タグと終了タグの間に含まれていません。

解説

<form runat=server> タグの内側に配置する必要があるコントロールが、表示される前にこのメソッドを呼び出すことができます。そのため、そのようなコントロールがタグの外側に配置された場合、エラーメッセージが表示されます。登録したスクリプトブロックをポストバックするコントロール、または登録したスクリプトブロックに依存するコントロールは、Control.Render メソッドのオーバーライド部で、このメソッドを呼び出す必要があります。サーバーフォーム要素の表示方法が異なっているページは、異なった条件の下でこのメソッドをオーバーライドして例外をスローできます。

クライアント側のスクリプトをポストバックまたは使用するサーバーコントロールは、HtmlForm サーバーコントロール (<form runat="server">) タグに囲まれていなければ動作しません。これらのコントロールは、HtmlForm コントロールに囲まれていない場合に、クリアエラーメッセージを表示するときに、このメソッドを呼び出すことができます。

カスタムサーバーコントロールを開発する場合は、通常、任意の種類の入力タグについて Render メソッドをオーバーライドするときに、このメソッドを呼び出します。これは、入力コントロールが GetPostBackEventReference を呼び出す場合、またはクライアントスクリプトを出力する場合に、特に重要になります。複合サーバーコントロールでは、この呼び出しを行う必要はありません。

使用例

カスタムサーバーコントロールの Page.Render メソッドをオーバーライドするコード例を次に示します。このコントロールが、保持している内容をページに書き込む場合、VerifyRenderingInServerForm メソッドを使用して、このコントロールが HtmlForm コントロールの開始タグと終了タグの間に配置されるようにしています。

Visual Basic

' Override the Render method to ensure that this control
' is nested in an HtmlForm server control, between a <form runat=server>
' opening tag and a </form> closing tag.
Protected Overrides Sub
 Render(ByVal writer As HtmlTextWriter)

    ' Ensure that the control is nested in a server form.
    If Not (Page Is Nothing)
 Then
        Page.VerifyRenderingInServerForm(Me)
    End If

    MyBase.Render(writer)

End Sub

// Override the Render method to ensure that this control
// is nested in an HtmlForm server control, between a <form runat=server>
// opening tag and a </form> closing tag.
protected override void Render(HtmlTextWriter
 writer) {
    // Ensure that the control is nested in a server form.
    if (Page != null) {
        Page.VerifyRenderingInServerForm(this);
    }
    base.Render(writer);
}

// Override the Render method to ensure that this control
// is nested in an HtmlForm server control, between a <form runat=server>
// opening tag and a </form> closing tag.
protected void Render(HtmlTextWriter writer)
{
    // Ensure that the control is nested in a server form.
    if (get_Page() != null) {
        get_Page().VerifyRenderingInServerForm(this);
    }
    super.Render(writer);
} //Render