This documentation is archived and is not being maintained.

ClientScriptManager::GetPostBackEventReference Method (Control, String, Boolean)

Returns a string to use in a client event to cause postback to the server. The reference string is defined by the specified control that handles the postback and a string argument of additional event information. Optionally, registers the event reference for validation.

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

public:
String^ GetPostBackEventReference(
	Control^ control, 
	String^ argument, 
	bool registerForEventValidation
)

Parameters

control
Type: System.Web.UI::Control
The server Control that processes the postback on the server.
argument
Type: System::String
A string of optional arguments to pass to control.
registerForEventValidation
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 postback.

ExceptionCondition
ArgumentNullException

The specified Control 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.

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, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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