Page.GetPostBackEventReference Method

Definition

Namespace:

System.Web.UI

Assembly:

System.Web.dll

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)	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.
GetPostBackEventReference(Control, String)	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.

GetPostBackEventReference(Control)

Caution

The recommended alternative is ClientScript.GetPostBackEventReference. http://go.microsoft.com/fwlink/?linkid=14202

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.

C#

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

Parameters

control

Control

The server control to process the postback on the server.

Returns

String

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

Attributes

ObsoleteAttribute

Examples

C#

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

Remarks

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

See also

• GetPostBackEventReference(Control, String)

GetPostBackEventReference(Control, String)

Caution

The recommended alternative is ClientScript.GetPostBackEventReference. http://go.microsoft.com/fwlink/?linkid=14202

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.

C#

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

Parameters

control

Control

The server control to process the postback.

argument

String

The parameter passed to the server control.

Returns

String

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

Attributes

ObsoleteAttribute

Examples

C#

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

Remarks

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

See also

• GetPostBackEventReference(Control)