Page.GetPostBackEventReference Page.GetPostBackEventReference Page.GetPostBackEventReference Method

Definition

Returns a string that can be used in a client event to cause postback to the server. This method has been deprecated. Use the GetPostBackEventReference method in the ClientScriptManager class instead.

Overloads

GetPostBackEventReference(Control) GetPostBackEventReference(Control) GetPostBackEventReference(Control)

Returns a string that can be used in a client event to cause postback to the server. The reference string is defined by the specified Control object.

GetPostBackEventReference(Control, String) GetPostBackEventReference(Control, String) GetPostBackEventReference(Control, String)

Returns a string that can be used in a client event to cause postback to the server. The reference string is defined by the specified control that handles the postback and a string argument of additional event information.

GetPostBackEventReference(Control) GetPostBackEventReference(Control) GetPostBackEventReference(Control)

Warning

This API is now obsolete.

Returns a string that can be used in a client event to cause postback to the server. The reference string is defined by the specified Control object.

public:
 System::String ^ GetPostBackEventReference(System::Web::UI::Control ^ control);
[System.Obsolete("The recommended alternative is ClientScript.GetPostBackEventReference. http://go.microsoft.com/fwlink/?linkid=14202")]
public string GetPostBackEventReference (System.Web.UI.Control control);
member this.GetPostBackEventReference : System.Web.UI.Control -> string

Parameters

control
Control Control Control

The server control to process the postback on the server.

Returns

A string that, when treated as script on the client, initiates the postback.

Examples

   public class MyControl1 : Control, IPostBackEventHandler
   {
      // Create an integer property that is displayed when
      // the page that contains this control is requested
      // and save it to the control's ViewState property.
      public int Number
      {
        get
        {
          if ( ViewState["Number"] !=null )
          return (int) ViewState["Number"];
          return 50;
        }

        set
        {
          ViewState["Number"] = value;
        }        
      }

      // Implement the RaisePostBackEvent method from the
      // IPostBackEventHandler interface. If 'inc' is passed
      // to this method, it increases the Number property by one.
      public void RaisePostBackEvent(string eventArgument)
      {
        Number = Number + 1;
      }

      
[System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")]
      protected override void Render(HtmlTextWriter writer)
      {
        // Converts the Number property to a string and
	// writes it to the containing page.
        writer.Write("The Number is " + Number.ToString() + " (" );

	// Uses the GetPostBackEventReference method to pass
	// 'inc' to the RaisePostBackEvent method when the link
	// this code creates is clicked.
        writer.Write("<a href=\"javascript:" + Page.GetPostBackEventReference(this) + "\">Increase Number</a>");
      }
   }
 Public Class MyControl1
    Inherits Control
    Implements IPostBackEventHandler 
    
    ' Create an integer property that is displayed when
    ' the page that contains this control is requested
    ' and save it to the control's ViewState property.
    Public Property Number() As Integer
       Get
          If Not (ViewState("Number") Is Nothing) Then
             Return CInt(ViewState("Number"))
          End If
          Return 50
       End Get
       
       Set
          ViewState("Number") = value
       End Set
    End Property
    

    ' Implement the RaisePostBackEvent method from the
    ' IPostBackEventHandler interface. If inc is passed
    ' to this method, it increases the Number property by one.      
    Public Sub RaisePostBackEvent(eventArgument As String) Implements IPostBackEventHandler.RaisePostBackEvent

       Number = Number + 1
    End Sub 'RaisePostBackEvent
    
    <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
    Protected Overrides Sub Render(writer As HtmlTextWriter)
       ' Converts the Number property to a string and
' writes it to the containing page.
       writer.Write(("The Number is " + Number.ToString() + " ("))

' Uses the GetPostBackEventReference method to pass
' inc to the RaisePostBackEvent method when the link
' this code creates is clicked.         
       writer.Write(("<a href=""javascript:" + Page.GetPostBackEventReference(Me) + """>Increase Number</a>"))
    End Sub 'Render
 End Class 'MyControl1

Remarks

This method has been deprecated. Use the GetPostBackEventReference method in the ClientScriptManager class instead.

See also

GetPostBackEventReference(Control, String) GetPostBackEventReference(Control, String) GetPostBackEventReference(Control, String)

Warning

This API is now obsolete.

Returns a string that can be used in a client event to cause postback to the server. The reference string is defined by the specified control that handles the postback and a string argument of additional event information.

public:
 System::String ^ GetPostBackEventReference(System::Web::UI::Control ^ control, System::String ^ argument);
[System.Obsolete("The recommended alternative is ClientScript.GetPostBackEventReference. http://go.microsoft.com/fwlink/?linkid=14202")]
public string GetPostBackEventReference (System.Web.UI.Control control, string argument);
member this.GetPostBackEventReference : System.Web.UI.Control * string -> string

Parameters

control
Control Control Control

The server control to process the postback.

argument
String String String

The parameter passed to the server control.

Returns

A string that, when treated as script on the client, initiates the postback.

Examples

   public class MyControl : Control, IPostBackEventHandler
   {
      
      // Create an integer property that is displayed when
      // the page that contains this control is requested
      // and save it to the control's ViewState property.
      public int Number
      {
        get
        {
          if ( ViewState["Number"] !=null )
             return (int) ViewState["Number"];
          return 50;
        }

        set
        {
          ViewState["Number"] = value;
        }        
      }

      // Implement the RaisePostBackEvent method from the
      // IPostBackEventHandler interface. If 'inc' is passed
      // to this method, it increases the Number property by one.
      // If 'dec' is passed to this method, it decreases the
      // Number property by one.
      public void RaisePostBackEvent(string eventArgument)
      {
        if ( eventArgument == "inc" )
        Number = Number + 1;

        if ( eventArgument == "dec" )
        Number = Number - 1;
      }

      
[System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")]
      protected override void Render(HtmlTextWriter writer)
      {
        // Converts the Number property to a string and
	// writes it to the containing page.
        writer.Write("The Number is " + Number.ToString() + " (" );

	// Uses the GetPostBackEventReference method to pass
	// 'inc' to the RaisePostBackEvent method when the link
	// this code creates is clicked.
        writer.Write("<a href=\"javascript:" + Page.GetPostBackEventReference(this,"inc") + "\">Increase Number</a>"); 

        writer.Write(" or ");

	// Uses the GetPostBackEventReference method to pass
	// 'dec' to the RaisePostBackEvent method when the link
	// this code creates is clicked.
        writer.Write("<a href=\"javascript:" + Page.GetPostBackEventReference(this,"dec") + "\">Decrease Number</a>");
      }
   }
 Public Class MyControl
    Inherits Control
    Implements IPostBackEventHandler

    ' Create an integer property that is displayed when
    ' the page that contains this control is requested
    ' and save it to the control's ViewState property.      
    Public Property Number() As Integer
       Get
          If Not (ViewState("Number") Is Nothing) Then
             Return CInt(ViewState("Number"))
          End If
          Return 50
       End Get
       
       Set
          ViewState("Number") = value
       End Set
    End Property      
    
    ' Implement the RaisePostBackEvent method from the
    ' IPostBackEventHandler interface. If inc is passed
    ' to this method, it increases the Number property by one.
    ' If dec is passed to this method, it decreases the
    ' Number property by one.
    Sub RaisePostBackEvent(eventArgument As String) Implements IPostBackEventHandler.RaisePostBackEvent

       If eventArgument = "inc" Then
          Number = Number + 1
       End If 
       If eventArgument = "dec" Then
          Number = Number - 1
       End If
    End Sub 'RaisePostBackEvent
    
    <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _ 
    Protected Overrides Sub Render(writer As HtmlTextWriter)
       ' Converts the Number property to a string and
' writes it to the containing page.
       writer.Write(("The Number is " + Number.ToString() + " ("))
       
' Uses the GetPostBackEventReference method to pass
' inc to the RaisePostBackEvent method when the link
' this code creates is clicked.
       writer.Write(("<a href=""javascript:" + Page.GetPostBackEventReference(Me, "inc") + """>Increase Number</a>"))
       
       writer.Write(" or ")

' Uses the GetPostBackEventReference method to pass
' dec to the RaisePostBackEvent method when the link
' this code creates is clicked.         
       writer.Write(("<a href=""javascript:" + Page.GetPostBackEventReference(Me, "dec") + """>Decrease Number</a>"))
    End Sub 'Render
 End Class 'MyControl

Remarks

This method has been deprecated. Use the GetPostBackEventReference method in the ClientScriptManager class instead.

See also

Applies to