This documentation is archived and is not being maintained.
Page.GetPostBackEventReference Method (Control, String)
Visual Studio 2010
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 that handles the postback and a string argument of additional event information.
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
Parameters
- control
- Type: System.Web.UI.Control
The server control to process the postback.
- argument
- Type: System.String
The parameter passed to the server control.
Return Value
Type: System.StringA 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
.NET Framework
Supported in: 1.1, 1.0Obsolete (compiler warning) in 4
Obsolete (compiler warning) in 3.5
Obsolete (compiler warning) in 3.5 SP1
Obsolete (compiler warning) in 3.0
Obsolete (compiler warning) in 3.0 SP1
Obsolete (compiler warning) in 3.0 SP2
Obsolete (compiler warning) in 2.0
Obsolete (compiler warning) in 2.0 SP1
Obsolete (compiler warning) in 2.0 SP2
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: