Export (0) Print
Expand All

ClientScriptManager.GetPostBackEventReference Method (PostBackOptions, Boolean)

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 PostBackOptions object. Optionally, registers the event reference for validation.

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

public string GetPostBackEventReference(
	PostBackOptions options,
	bool registerForEventValidation


Type: System.Web.UI.PostBackOptions

A PostBackOptions that defines the postback.

Type: System.Boolean

true to register the event reference for validation; otherwise, false.

Return Value

Type: System.String
A string that, when treated as script on the client, initiates the client postback.


The PostBackOptions is null.

To implement the IPostBackEventHandler interface for a Page object, use the @ Implements directive.

The GetPostBackEventReference method can be used with the Button control when the UseSubmitBehavior property is false. In this scenario, the GetPostBackEventReference method returns the client postback event for the Button control.

If registerForEventValidation is true, the GetPostBackEventReference(PostBackOptions, Boolean) method calls the RegisterForEventValidation(String, String) method to register the event reference for validation with a unique control ID that represents the client control that is generating the event.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

© 2014 Microsoft