Page.GetPostBackEventReference Method (Control, String)

NOTE: This method 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.

Namespace: System.Web.UI
Assembly: System.Web (in system.web.dll)

'Declaration
<ObsoleteAttribute("The recommended alternative is ClientScript.GetPostBackEventReference. http://go.microsoft.com/fwlink/?linkid=14202")> _
Public Function GetPostBackEventReference ( _
	control As Control, _
	argument As String _
) As String
'Usage
Dim instance As Page
Dim control As Control
Dim argument As String
Dim returnValue As String

returnValue = instance.GetPostBackEventReference(control, argument)
/** @attribute ObsoleteAttribute("The recommended alternative is ClientScript.GetPostBackEventReference. http://go.microsoft.com/fwlink/?linkid=14202") */ 
public String GetPostBackEventReference (
	Control control, 
	String argument
)
ObsoleteAttribute("The recommended alternative is ClientScript.GetPostBackEventReference. http://go.microsoft.com/fwlink/?linkid=14202") 
public function GetPostBackEventReference (
	control : Control, 
	argument : String
) : String
Not applicable.

Parameters

control

The server control to process the postback.

argument

The parameter passed to the server control.

Return Value

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

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

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

public class MyControl extends 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.
    /** @property 
     */
    public int get_Number()
    {
        if (get_ViewState().get_Item("Number") != null) {
            return System.Convert.ToInt32(get_ViewState().get_Item("Number"));
        }
        return 50;
    } //get_Number

    /** @property 
     */
    public void set_Number(int value)
    {
        get_ViewState().set_Item("Number", (Int32)value);
    } //set_Number

    // 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.Equals("inc")) {
            set_Number(get_Number() + 1);
        }
        if (eventArgument.Equals("dec")) {
            set_Number(get_Number() - 1);
        }
    } //RaisePostBackEvent

    protected void Render(HtmlTextWriter writer)
    {
        // Converts the Number property to a string and
        // writes it to the containing page.
        writer.Write("The Number is " + ((Int32)get_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:" + get_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:" + get_Page().
            GetPostBackEventReference(this, "dec") 
            + "\">Decrease Number</a>");
    } //Render
} //MyControl

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 1.0, 1.1, 2.0
Obsolete (compiler warning) in 3.0

Community Additions

ADD
Show: