Page.GetPostBackEventReference Method (Control)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Note: 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.

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

[ObsoleteAttribute("The recommended alternative is ClientScript.GetPostBackEventReference.")]
public string GetPostBackEventReference(
	Control control


Type: System.Web.UI.Control

The server control to process the postback on the server.

Return Value

Type: System.String

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 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
          if ( ViewState["Number"] !=null )
          return (int) ViewState["Number"];
          return 50;

          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>");

.NET Framework
Available since 1.1
Return to top