ClientScriptManager.GetPostBackEventReference 方法

参考

定义

命名空间:: System.Web.UI

程序集:: System.Web.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

返回一个可以在客户端事件中使用的字符串，以便回发到服务器。

重载

GetPostBackEventReference(Control, String, Boolean)	返回一个在客户端事件中使用的字符串，以便回发到服务器。该引用字符串由处理回发的指定控件和一个附加事件信息的字符串参数定义。可选择为验证注册事件引用。
GetPostBackEventReference(PostBackOptions, Boolean)	返回一个可以在客户端事件中使用的字符串，以便回发到服务器。由指定的 PostBackOptions 对象定义的字符串。可选择为验证注册事件引用。
GetPostBackEventReference(PostBackOptions)	返回一个可以在客户端事件中使用的字符串，以便回发到服务器。由指定的 PostBackOptions 实例定义的字符串。
GetPostBackEventReference(Control, String)	返回一个可以在客户端事件中使用的字符串，以便回发到服务器。该引用字符串由处理回发的指定控件和一个附加事件信息的字符串参数定义。

GetPostBackEventReference(Control, String, Boolean)

返回一个在客户端事件中使用的字符串，以便回发到服务器。该引用字符串由处理回发的指定控件和一个附加事件信息的字符串参数定义。可选择为验证注册事件引用。

public:
 System::String ^ GetPostBackEventReference(System::Web::UI::Control ^ control, System::String ^ argument, bool registerForEventValidation);

public string GetPostBackEventReference (System.Web.UI.Control control, string argument, bool registerForEventValidation);

member this.GetPostBackEventReference : System.Web.UI.Control * string * bool -> string

Public Function GetPostBackEventReference (control As Control, argument As String, registerForEventValidation As Boolean) As String

参数

control: Control

在服务器上处理回发的服务器 Control。

argument: String

传递给 control 的可选参数的字符串。

registerForEventValidation: Boolean

true 表示为验证注册事件引用；否则为 false。

String

一个字符串，将其视为客户端脚本时，将启动回发。

例外

ArgumentNullException

指定的 Control 为 null。

注解

若要实现 IPostBackEventHandler 的 Page接口，请使用 @ Implements 指令。

当 GetPostBackEventReference 属性为 false时UseSubmitBehavior， Button 方法可与控件一起使用。在此方案中， GetPostBackEventReference 方法返回控件的客户端回发事件 Button 。

如果 registerForEventValidation 为 true，则 GetPostBackEventReference(PostBackOptions, Boolean) 该方法调用 RegisterForEventValidation(String, String) 方法以使用表示正在生成事件的客户端控件的唯一控件 ID 注册事件引用进行验证。

另请参阅

适用于

.NET Framework 4.8.1 和其他版本

产品	版本
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

GetPostBackEventReference(PostBackOptions, Boolean)

返回一个可以在客户端事件中使用的字符串，以便回发到服务器。由指定的 PostBackOptions 对象定义的字符串。可选择为验证注册事件引用。

public:
 System::String ^ GetPostBackEventReference(System::Web::UI::PostBackOptions ^ options, bool registerForEventValidation);

public string GetPostBackEventReference (System.Web.UI.PostBackOptions options, bool registerForEventValidation);

member this.GetPostBackEventReference : System.Web.UI.PostBackOptions * bool -> string

Public Function GetPostBackEventReference (options As PostBackOptions, registerForEventValidation As Boolean) As String

参数

options: PostBackOptions

定义回发的 PostBackOptions。

registerForEventValidation: Boolean

true 表示为验证注册事件引用；否则为 false。

String

一个字符串，当被视为客户端脚本时，它将启动客户端回发。

例外

ArgumentNullException

PostBackOptions 为 null。

注解

若要实现 IPostBackEventHandler Page 对象的接口，请使用 @ Implements 指令。

如果 registerForEventValidation 为 true，则 GetPostBackEventReference(PostBackOptions, Boolean) 方法调用 RegisterForEventValidation(String, String) 方法以注册事件引用以使用唯一控件 ID 进行验证，该 ID 表示正在生成事件的客户端控件。

另请参阅

适用于

.NET Framework 4.8.1 和其他版本

产品	版本
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

GetPostBackEventReference(PostBackOptions)

返回一个可以在客户端事件中使用的字符串，以便回发到服务器。由指定的 PostBackOptions 实例定义的字符串。

public:
 System::String ^ GetPostBackEventReference(System::Web::UI::PostBackOptions ^ options);

public string GetPostBackEventReference (System.Web.UI.PostBackOptions options);

member this.GetPostBackEventReference : System.Web.UI.PostBackOptions -> string

Public Function GetPostBackEventReference (options As PostBackOptions) As String

参数

options: PostBackOptions

定义回发的 PostBackOptions。

String

一个字符串，当被视为客户端脚本时，它将启动客户端回发。

例外

ArgumentNullException

PostBackOptions 参数为 null

注解

若要实现 IPostBackEventHandler 的 Page接口，请使用 @ Implements 指令。

另请参阅

适用于

.NET Framework 4.8.1 和其他版本

产品	版本
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

GetPostBackEventReference(Control, String)

返回一个可以在客户端事件中使用的字符串，以便回发到服务器。该引用字符串由处理回发的指定控件和一个附加事件信息的字符串参数定义。

public:
 System::String ^ GetPostBackEventReference(System::Web::UI::Control ^ control, System::String ^ argument);

public string GetPostBackEventReference (System.Web.UI.Control control, string argument);

member this.GetPostBackEventReference : System.Web.UI.Control * string -> string

Public Function GetPostBackEventReference (control As Control, argument As String) As String

参数

control: Control

在服务器上处理回发的服务器 Control。

argument: String

要传递给处理回发的控件的可选参数字符串。

String

一个字符串，将其视为客户端脚本时，将启动回发。

例外

ArgumentNullException

指定的 Control 为 null。

示例

下面的代码示例演示如何使用 GetPostBackEventReference 方法。自定义控件 MyControl实现 IPostBackEventHandler 接口。单击页面上的按钮时， RaisePostBackEvent 将调用自定义控件的方法。

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  public class MyControl : Label, IPostBackEventHandler
  {

    // Use the constructor to defined default label text.
    public MyControl()
    {
      base.Text = "No postback raised.";
    }
    
    // Implement the RaisePostBackEvent method from the
    // IPostBackEventHandler interface. 
    public void RaisePostBackEvent(string eventArgument)
    {
      base.Text = "Postback handled by " + this.ID.ToString() + ". <br/>" +
                  "Postback caused by " + eventArgument.ToString() + ".";
      
    }
  }

  protected void Page_Load(object sender, EventArgs e)
  {
    // Get a ClientScriptManager reference from the Page class.
    ClientScriptManager cs = Page.ClientScript;

    // Create an instance of the custom label control and 
    // add it to the page.
    MyControl mycontrol = new MyControl();
    mycontrol.ID = "mycontrol1";
    PlaceHolder1.Controls.Add(mycontrol);
    PlaceHolder1.Controls.Add(new LiteralControl("<br/>"));
    
    // Create a button element with its onClick attribute defined
    // to create a postback event reference to the custom label control.
    HtmlInputButton b = new HtmlInputButton();
    b.ID = "mybutton1";
    b.Value = "Click";
    b.Attributes.Add("onclick", cs.GetPostBackEventReference(mycontrol, b.ID.ToString()));
    PlaceHolder1.Controls.Add(b);
    PlaceHolder1.Controls.Add(new LiteralControl("<br/>"));
    
    // Create a link element with its href attribute defined
    // to create a postback event reference to the custom label control.
    HtmlAnchor a = new HtmlAnchor();
    a.ID = "myanchor1";
    a.InnerText = "link";
    a.HRef = cs.GetPostBackClientHyperlink(mycontrol, a.ID.ToString());
    PlaceHolder1.Controls.Add(a);
  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ClientScriptManager Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:PlaceHolder id="PlaceHolder1" 
                       runat="server">
      </asp:PlaceHolder>
    </div>
    </form>
</body>
</html>

<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
  
  Public Class MyControl
    Inherits Label
    Implements IPostBackEventHandler
     
    Public Sub New()
      
      MyBase.Text = "No postback raised."
    
    End Sub
    
    Public Sub RaisePostBackEvent(ByVal eventArgument As String) Implements System.Web.UI.IPostBackEventHandler.RaisePostBackEvent
      
      MyBase.Text = "Postback handled by " & Me.ID.ToString() & ". <br/>" & _
                "Postback caused by " + eventArgument.ToString() & "."

    End Sub
    
  End Class
   

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

    ' Get a ClientScriptManager reference from the Page class.
    Dim cs As ClientScriptManager = Page.ClientScript

    ' Create an instance of the custom label control and 
    ' add it to the page.
    Dim mycontrol As New MyControl()
    MyControl.ID = "mycontrol1"
    PlaceHolder1.Controls.Add(MyControl)
    PlaceHolder1.Controls.Add(New LiteralControl("<br/>"))
    
    ' Create a button element with its onClick attribute defined
    ' to create a postback event reference to the custom label control.
    Dim b As New HtmlInputButton()
    b.ID = "mybutton1"
    b.Value = "Click"
    b.Attributes.Add("onclick", cs.GetPostBackEventReference(MyControl, b.ID.ToString()))
    PlaceHolder1.Controls.Add(b)
    PlaceHolder1.Controls.Add(New LiteralControl("<br/>"))
    
    ' Create a link element with its href attribute defined
    ' to create a postback event reference to the custom label control.
    Dim a As New HtmlAnchor()
    a.ID = "myanchor1"
    a.InnerText = "link"
    a.HRef = cs.GetPostBackClientHyperlink(MyControl, a.ID.ToString())
    PlaceHolder1.Controls.Add(a)
    
  End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ClientScriptManager Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:PlaceHolder id="PlaceHolder1" 
                       runat="server">
      </asp:PlaceHolder>
    </div>
    </form>
</body>
</html>

下面的代码示例具有与上一个代码示例相同的功能，只不过类实现 IPostBackEventHandler 接口而不是自定义控件Page。

<%@ Page Language="C#"  %>
<%@ Implements Interface="System.Web.UI.IPostBackEventHandler" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
  
  public void RaisePostBackEvent(string eventArgument)
  {
    Label1.Text = "Postback handled by " + this.ID.ToString() + ". <br/>" +
                  "Postback caused by " + eventArgument.ToString() + "."; ;
  }
  
  protected void Page_Load(object sender, EventArgs e)
  {
    // Get a ClientScriptManager reference from the Page class.
    ClientScriptManager cs = Page.ClientScript;
    
    // Create a button element with its onClick attribute defined
    // to create a postback event reference to the custom label control.
    HtmlInputButton b = new HtmlInputButton();
    b.ID = "mybutton1";
    b.Value = "Click";
    b.Attributes.Add("onclick", cs.GetPostBackEventReference(this, b.ID.ToString()));
    PlaceHolder1.Controls.Add(b);
    PlaceHolder1.Controls.Add(new LiteralControl("<br/>"));
    
    // Create a link element with its href attribute defined
    // to create a postback event reference to the custom label control.
    HtmlAnchor a = new HtmlAnchor();
    a.ID = "myanchor1";
    a.InnerText = "link";
    a.HRef = cs.GetPostBackClientHyperlink(this, a.ID.ToString());
    PlaceHolder1.Controls.Add(a);
  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ClientScriptManager Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:Label id="Label1"
                 runat="server" />
      <br />
      <asp:PlaceHolder id="PlaceHolder1" 
                       runat="server">
      </asp:PlaceHolder>
    </div>
    </form>
</body>
</html>

<%@ Page Language="VB" %>
<%@ Implements Interface="System.Web.UI.IPostBackEventHandler" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
 
  Public Sub RaisePostBackEvent(ByVal eventArgument As String) _
    Implements IPostBackEventHandler.RaisePostBackEvent
    
    Label1.Text = "Postback handled by " & Me.ID.ToString() & ". <br/>" & _
           "Postback caused by " + eventArgument.ToString() & "."
  
  End Sub
  

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

    ' Get a ClientScriptManager reference from the Page class.
    Dim cs As ClientScriptManager = Page.ClientScript
    
    ' Create a button element with its onClick attribute defined
    ' to create a postback event reference to the custom label control.
    Dim b As New HtmlInputButton()
    b.ID = "mybutton1"
    b.Value = "Click"
    b.Attributes.Add("onclick", cs.GetPostBackEventReference(Me, b.ID.ToString()))
    PlaceHolder1.Controls.Add(b)
    PlaceHolder1.Controls.Add(New LiteralControl("<br/>"))
    
    ' Create a link element with its href attribute defined
    ' to create a postback event reference to the custom label control.
    Dim a As New HtmlAnchor()
    a.ID = "myanchor1"
    a.InnerText = "link"
    a.HRef = cs.GetPostBackClientHyperlink(Me, a.ID.ToString())
    PlaceHolder1.Controls.Add(a)
    
  End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ClientScriptManager Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:Label id="Label1"
                 runat="server" />
      <br />
      <asp:PlaceHolder id="PlaceHolder1" 
                       runat="server">
      </asp:PlaceHolder>
    </div>
    </form>
</body>
</html>

注解

若要实现 IPostBackEventHandler 的 Page接口，请使用 @ Implements 指令。

另请参阅

适用于

.NET Framework 4.8.1 和其他版本

产品	版本
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

未来属于你

通过

ClientScriptManager.GetPostBackEventReference 方法

定义

重载

GetPostBackEventReference(Control, String, Boolean)

参数

返回

例外

注解

另请参阅

适用于

GetPostBackEventReference(PostBackOptions, Boolean)

参数

返回

例外

注解

另请参阅

适用于

GetPostBackEventReference(PostBackOptions)

参数

返回

例外

注解

另请参阅

适用于

GetPostBackEventReference(Control, String)

参数

返回

例外

示例

注解

另请参阅

适用于

其他资源