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

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

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

ClientScriptManager.RegisterOnSubmitStatement メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

型、キー、およびスクリプトリテラルを使用して、OnSubmit ステートメントを Page オブジェクトに登録します。ステートメントは、HtmlForm が送信されると、実行されます。

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

Visual Basic (宣言)

Public Sub RegisterOnSubmitStatement ( _
    type As Type, _
    key As String, _
    script As String _
)

Visual Basic (使用法)

Dim instance As ClientScriptManager
Dim type As Type
Dim key As String
Dim script As String

instance.RegisterOnSubmitStatement(type, key, script)

public void RegisterOnSubmitStatement (
    Type type,
    string key,
    string script
)

C++

public:
void RegisterOnSubmitStatement (
    Type^ type, 
    String^ key, 
    String^ script
)

public void RegisterOnSubmitStatement (
    Type type, 
    String key, 
    String script
)

JScript

public function RegisterOnSubmitStatement (
    type : Type, 
    key : String, 
    script : String
)

パラメータ

type: 登録する OnSubmit ステートメントの型。

key: 登録する OnSubmit ステートメントのキー。

script: 登録する OnSubmit ステートメントのスクリプトリテラル。

解説

OnSubmit ステートメントは、そのキーと型で一意に識別されます。同じキーと型を持つステートメントは重複していると見なされます。同じ型とキーのペアを持つステートメントは、同じページに 1 つだけ登録できます。既に登録されているステートメントを登録しようとしても、重複したステートメントは作成されません。

IsOnSubmitStatementRegistered メソッドを呼び出して、任意のキーと型のペアを持つ OnSubmit ステートメントが既に登録されていないか確認し、スクリプトを不要に追加しようとする手間を省きます。

RegisterOnSubmitStatement メソッドの script パラメータには、複数のスクリプトコマンドを含めることができます。これらはセミコロン (;) で区切る必要があります。

RegisterOnSubmitStatement は、ページが送信される前に実行されるスクリプトを追加し、送信をキャンセルする機会を提供します。

HTML フォームと OnSubmit 属性の詳細については、W3C (World Wide Web Consortium) Web サイト () を参照してください。

使用例

RegisterOnSubmitStatement メソッドの使用方法を示すコード例を次に示します。

Visual Basic

<%@ Page Language="VB" %>

<script runat="server">

  Protected Sub Page_Load(ByVal
 sender As Object, ByVal
 e As System.EventArgs)

    ' Define the name and type of the client script on the page.
    Dim csname As String
 = "OnSubmitScript"
    Dim cstype As Type = Me.GetType()
    
    ' Get a ClientScriptManager reference from the Page class.
    Dim cs As ClientScriptManager = Page.ClientScript
    
    ' Check to see if the OnSubmit statement is already registered.
    If (Not cs.IsOnSubmitStatementRegistered(cstype,
 csname)) Then
      
      Dim cstext As String
 = "document.write('Text from OnSubmit statement.');"
      cs.RegisterOnSubmitStatement(cstype, csname, cstext)
      
    End If
    
  End Sub
  
</script>

<html>
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form    id="Form1"
            runat="server">
     <input type="submit"
            value="Submit">
     </form>
  </body>
</html>

<%@ Page Language="C#"%>
<script runat="server">
  public void Page_Load(Object sender, EventArgs
 e)
  {
    // Define the name and type of the client script on the page.
    String csname = "OnSubmitScript";
    Type cstype = this.GetType();
        
    // Get a ClientScriptManager reference from the Page class.
    ClientScriptManager cs = Page.ClientScript;

    // Check to see if the OnSubmit statement is already registered.
    if (!cs.IsOnSubmitStatementRegistered(cstype, csname))
    {
      String cstext = "document.write('Text from OnSubmit statement');";
      cs.RegisterOnSubmitStatement(cstype, csname, cstext);
    }

  }
</script>
<html>
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form    id="Form1"
            runat="server">
     <input type="submit"
            value="Submit">
     </form>
  </body>
</html>

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ClientScriptManager クラス
ClientScriptManager メンバ
System.Web.UI 名前空間
HtmlForm
IsOnSubmitStatementRegistered

>> 「ClientScriptManager.RegisterOnSubmitStatement メソッド」を含む用語の索引
ClientScriptManager.RegisterOnSubmitStatement メソッドのページへのリンク


	© 2024 Microsoft.All rights reserved.

ClientScriptManager.RegisterOnSubmitStatement メソッドとは？ わかりやすく解説

ClientScriptManager.RegisterOnSubmitStatement メソッド

急上昇のことば

ClientScriptManager.RegisterOnSubmitStatement メソッドとは？わかりやすく解説