クライアント コールバックの実装例 (C#)

更新 : 2007 年 11 月

クライアント コールバックを実装する ASP.NET Web ページの例を示します。詳細については、「ASP.NET Web ページでポストバックせずにプログラムによってクライアント コールバックを実装する」を参照してください。

説明

次のコードの例は、2 つの部分に分かれています。最初の部分は、ASP.NET Web ページ (.aspx ページ) です。2 番目の部分は、対応する分離コード ファイル (.aspx.cs ファイル) です。

コード

<%@ Page Language="C#" AutoEventWireup="true" 
  CodeFile="ClientCallback.aspx.cs" Inherits="ClientCallback" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 
  1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
  <title>Client Callback Example</title>
  <script type="text/ecmascript">
    function LookUpStock()
    {
        var lb = document.getElementById("ListBox1");
        var product = lb.options[lb.selectedIndex].text;
        CallServer(product, "");
    }

    function ReceiveServerData(rValue)
    {   
        document.getElementById("ResultsSpan").innerHTML = rValue;

    }
  </script>
</head>
<body>
  <form id="form1" runat="server">
    <div>
      <asp:ListBox ID="ListBox1" Runat="server"></asp:ListBox>
      <br />
      <br />
      <button type="Button" onclick="LookUpStock()">Look Up Stock</button>
      <br />
      <br />
      Items in stock: <span id="ResultsSpan" runat="server"></span>
      <br />
    </div>
  </form>
</body>
</html>
using System;
using System.Data;
using System.Configuration;
using System.Collections;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

public partial class ClientCallback : System.Web.UI.Page,
     System.Web.UI.ICallbackEventHandler
{
    protected System.Collections.Specialized.ListDictionary catalog;
    protected String returnValue;
    protected void Page_Load(object sender, EventArgs e)
    {
        String cbReference =
            Page.ClientScript.GetCallbackEventReference(this,
            "arg", "ReceiveServerData", "context");
        String callbackScript;
        callbackScript = "function CallServer(arg, context)" +
            "{ " + cbReference + ";}";
        Page.ClientScript.RegisterClientScriptBlock(this.GetType(),
            "CallServer", callbackScript, true);

        catalog = new System.Collections.Specialized.ListDictionary();
        catalog.Add("monitor", 12);
        catalog.Add("laptop", 10);
        catalog.Add("keyboard", 23);
        catalog.Add("mouse", 17);

        ListBox1.DataSource = catalog;
        ListBox1.DataTextField = "key";
        ListBox1.DataBind();

    }

    public void RaiseCallbackEvent(String eventArgument)
    {
        if (catalog[eventArgument] == null)
        {
            returnValue = "-1";
        }
        else
        {
            returnValue = catalog[eventArgument].ToString();
        }
    }
    public String GetCallbackResult()
    {
        return returnValue;
    }
}

コメント

この Web ページでは、モニタやキーボードなどの一連の製品の有効な在庫項目の数を確認するためにデータベース ルックアップをエミュレートします。このコード例では、簡略化のためにデータベースは少数の項目を含む辞書式のリストで表されています。テーブルの各項目のキーはモニタなどの項目の名前で、値は項目の在庫数です。実際のアプリケーションでは、代わりにデータベースを使用します。

このページが実行されると、ListBox コントロールがハッシュ テーブルにバインドされ、ListBox コントロールに製品の一覧が表示されます。このページには button 要素もあり (Button Web サーバー コントロールではありません)、この要素の onclick イベントは LookUpStock というクライアント関数にバインドされます。ボタンがクリックされると実行される LookUpStock 関数は、リスト ボックスから現在の選択内容を取得し、CallServer 関数を呼び出してクライアント コールバックを実行します。

分離コード ページは、RegisterClientScriptBlock メソッドを使用してクライアント側スクリプトをページに追加します。ページに追加されるスクリプトには CallServer という関数があり、この関数は GetCallbackEventReference メソッドからサーバーにポストバックするメソッドの名前を取得します。

クライアント コールバックは RaiseCallbackEvent メソッドを呼び出し、このメソッドは渡された製品の有効在庫を確認します。GetCallbackResult メソッドはその値を返します。クライアント スクリプトとサーバー コード間でやり取りする引数は文字列にする必要があることに注意してください。複数の値を渡す場合、または受け取る場合、それぞれ入力または戻り値の文字列で値を連結できます。

ms178210.alert_security(ja-jp,VS.90).gifセキュリティに関するメモ :

この機能を使用するときは、セキュリティが脆弱になる可能性があります。コールバック引数は検証されないので、安全ではないと考えるべきです。引数を使用する前に、常に内容をチェックする必要があります。詳細については、「スクリプトによる攻略の概要」を参照してください。

参照

処理手順

方法 : ASP.NET Web ページにコールバックを実装する

概念

ASP.NET Web ページでポストバックせずにプログラムによってクライアント コールバックを実装する

検証付きクライアント コールバックの実装例