GetPostBackEventReference Method (PostBackOptions, Boolean)

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.

Exception Condition

The PostBackOptions is null.

To implement the IPostBackEventHandler interface for a Page object, use the 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
Available since 2.0
Return to top
© 2015 Microsoft