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
)

Parameters

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.

ExceptionCondition
ArgumentNullException

The PostBackOptions parameter is nullptr

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 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: