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

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

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

ClientScriptManager.RegisterHiddenField メソッド

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

隠し値を Page オブジェクトに登録します。

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

Visual Basic (宣言)

Public Sub RegisterHiddenField ( _
    hiddenFieldName As String, _
    hiddenFieldInitialValue As String _
)

Visual Basic (使用法)

Dim instance As ClientScriptManager
Dim hiddenFieldName As String
Dim hiddenFieldInitialValue As String

instance.RegisterHiddenField(hiddenFieldName, hiddenFieldInitialValue)

public void RegisterHiddenField (
    string hiddenFieldName,
    string hiddenFieldInitialValue
)

C++

public:
void RegisterHiddenField (
    String^ hiddenFieldName, 
    String^ hiddenFieldInitialValue
)

public void RegisterHiddenField (
    String hiddenFieldName, 
    String hiddenFieldInitialValue
)

JScript

public function RegisterHiddenField (
    hiddenFieldName : String, 
    hiddenFieldInitialValue : String
)

パラメータ

hiddenFieldName: 登録する隠しフィールドの名前。

hiddenFieldInitialValue: 登録するフィールドの初期値。

解説

RegisterHiddenField メソッドは、レンダリングされた HTML ページ上に隠し <input> 要素を作成します。

使用例

RegisterArrayDeclaration メソッドと RegisterHiddenField メソッドの使用方法を示すコード例を次に示します。この例では、配列と隠し値を登録し、配列の 2 つの値と隠し値の合計を計算する <input> ボタンの OnClick イベントを定義します。

Visual Basic

<%@ Page Language="VB" %>

<script runat="server">

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

    ' Define the array name and values.
    Dim arrName As String
 = "MyArray"
    Dim arrValue As String
 = """1"", ""2"",
 ""text"""
    
    ' Define the hidden field name and initial value.
    Dim hiddenName As String
 = "MyHiddenField"
    Dim hiddenValue As String
 = "3"
    
    ' Define script name and type.
    Dim csname As String
 = "ConcatScript"
    Dim cstype As Type = Me.GetType()
        
    ' Get a ClientScriptManager reference from the Page class.
    Dim cs As ClientScriptManager = Page.ClientScript

    ' Register the array with the Page class.
    cs.RegisterArrayDeclaration(arrName, arrValue)
    
    ' Register the hidden field with the Page class.
    cs.RegisterHiddenField(hiddenName, hiddenValue)

    ' Check to see if the  script is already registered.
    If (Not cs.IsClientScriptBlockRegistered(cstype,
 csname)) Then
      Dim cstext As StringBuilder = New
 StringBuilder()
      cstext.Append("<script type=text/javascript> function
 DoClick() {")
      cstext.Append("Form1.Message.value='Sum = ' + ")
      cstext.Append("(parseInt(" + arrName + "[0])+")
      cstext.Append("parseInt(" + arrName + "[1])+")
      cstext.Append("parseInt(" + Form1.Name + "."
 + hiddenName + ".value));} </")
      cstext.Append("script>")
      cs.RegisterClientScriptBlock(cstype, csname, cstext.ToString(), False)
    End If
    
  End Sub
  
</script>

<html>
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form    id="Form1"
            runat="server">
     <input type="text"
            id="Message" />
     <input type="button" 
            onclick="DoClick()" 
            value="Run Script">
     </form>
  </body>
</html>

<%@ Page Language="C#"%>

<script runat="server">
 
  public void Page_Load(Object sender, EventArgs
 e)
  {
    // Define the array name and values.
    String arrName = "MyArray";
    String arrValue = "\"1\", \"2\", \"text\"";
    
    // Define the hidden field name and initial value.
    String hiddenName = "MyHiddenField";
    String hiddenValue = "3";
    
    // Define script name and type.
    String csname = "ConcatScript";
    Type cstype = this.GetType();
        
    // Get a ClientScriptManager reference from the Page class.
    ClientScriptManager cs = Page.ClientScript;

    // Register the array with the Page class.
    cs.RegisterArrayDeclaration(arrName, arrValue);

    // Register the hidden field with the Page class.
    cs.RegisterHiddenField(hiddenName, hiddenValue);

    // Check to see if the  script is already registered.
    if (!cs.IsClientScriptBlockRegistered(cstype, csname))
    {
      StringBuilder cstext = new StringBuilder();
      cstext.Append("<script type=text/javascript> function DoClick()
 {");
      cstext.Append("Form1.Message.value='Sum = ' + ");
      cstext.Append("(parseInt(" + arrName + "[0])+");
      cstext.Append("parseInt(" + arrName + "[1])+");
      cstext.Append("parseInt(" + Form1.Name + "." + hiddenName
 + ".value));} </");
      cstext.Append("script>");
      cs.RegisterClientScriptBlock(cstype, csname, cstext.ToString(), false);
    }
  }
</script>
<html>
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form    id="Form1"
            runat="server">
     <input type="text"
            id="Message" />
     <input type="button" 
            onclick="DoClick()" 
            value="Run Script">
     </form>
  </body>
</html>