客户端回调实现 (Visual Basic) 示例

项目
10/22/2014

更新：2007 年 11 月

演示实现客户端回调的 ASP.NET 网页。有关更多信息，请参见在 ASP.NET 网页中不经过回发而以编程方式实现客户端回调。

示例

说明

下面的代码示例分为两部分。示例的第一部分演示一个 ASP.NET 网页（.aspx 页）。第二部分演示相应的代码隐藏文件（.aspx.vb 文件）。

代码

<%@ Page Language="VB" AutoEventWireup="true" 
  CodeFile="ClientCallback.aspx.vb" 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/javascript">
    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>

Partial Class ClientCallback
    Inherits System.Web.UI.Page
    Implements System.Web.UI.ICallbackEventHandler

    Protected catalog As ListDictionary
    Protected returnValue As String
    Sub Page_Load(ByVal sender As Object, ByVal e As _
        System.EventArgs) Handles Me.Load
        Dim cbReference As String
        cbReference = Page.ClientScript.GetCallbackEventReference(Me, _
            "arg", "ReceiveServerData", "context")
        Dim callbackScript As String = ""
        callbackScript &= "function CallServer(arg, context) { " & _
            cbReference & "} ;"
        Page.ClientScript.RegisterClientScriptBlock(Me.GetType(), _
            "CallServer", callbackScript, True)

        ' Populate List Dictionary with invented database data
        catalog = New 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()
    End Sub

    Public Sub RaiseCallbackEvent(ByVal eventArgument As String) _
    Implements System.Web.UI.ICallbackEventHandler.RaiseCallbackEvent

        If catalog(eventArgument) Is Nothing Then
            returnValue = "-1"
        Else
            returnValue = catalog(eventArgument).ToString()
        End If

    End Sub

    Public Function GetCallbackResult() _
    As String Implements _
    System.Web.UI.ICallbackEventHandler.GetCallbackResult

        Return returnValue

    End Function

End Class

注释

该网页模拟一个数据库查找，以确定一系列产品（监视器、键盘等）的供货数量或库存数量。为了简化此代码示例，数据库由包含少量物品的词典列表来表示。对于表中的每件物品，键就是物品名称（如监视器），值就是物品的库存数。但是在成品应用程序中，将使用数据库。

当运行此页时，ListBox 控件被绑定到哈希表，这样，ListBox 控件便可以显示产品列表。此页还包含一个 button 元素（非 Button Web 服务器控件），其 onclick 事件被绑定到一个名为 LookUpStock 的客户端函数。当用户单击按钮时，该按钮便会执行 LookUpStock 函数，此函数从列表框中获取当前所选内容，然后通过调用 CallServer 函数来执行客户端回调。

代码隐藏页通过 RegisterClientScriptBlock 方法向该页添加客户端脚本。添加到该页的脚本包括一个称为 CallServer 的函数，此函数用于获取将从 GetCallbackEventReference 方法回发到服务器的方法的名称。

客户端回调会调用 RaiseCallbackEvent 方法，该方法将确定传递给它的产品的可用库存。GetCallbackResult 方法将返回该值。请注意，在客户端脚本与服务器代码之间发送的参数只能是字符串。若要传入或接收多个值，可以分别在输入字符串或返回字符串中将这些值串连起来。

安全说明：
使用此功能时，存在潜在的安全威胁。由于不对回调参数进行验证，因此存在一定的不安全因素。每次使用参数之前，都应对参数的内容进行检查。有关详细信息，请参见脚本侵入概述。