This documentation is archived and is not being maintained.

ClientScriptManager.GetPostBackEventReference Method (PostBackOptions)

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
public String GetPostBackEventReference (
	PostBackOptions options
public function GetPostBackEventReference (
	options : PostBackOptions
) : String
Not applicable.



A PostBackOptions that defines the postback.

Return Value

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

Exception typeCondition


The PostBackOptions parameter is a null reference (Nothing in Visual Basic)

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

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0