ClientScriptManager.GetPostBackEventReference Method (PostBackOptions)


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

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 instance.

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

public string GetPostBackEventReference(
	PostBackOptions options


Type: System.Web.UI.PostBackOptions

A PostBackOptions that defines the postback.

Return Value

Type: System.String

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

Exception Condition

The PostBackOptions parameter is null

To implement the IPostBackEventHandler interface for a Page, 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.

.NET Framework
Available since 2.0
Return to top