GetCallbackEventReference Method (Control, String, String, String, Boolean)

ClientScriptManager.GetCallbackEventReference Method (Control, String, String, String, Boolean)

 

Obtains a reference to a client function that, when invoked, initiates a client call back to server events. The client function for this overloaded method includes a specified control, argument, client script, context, and Boolean value.

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

public string GetCallbackEventReference(
	Control control,
	string argument,
	string clientCallback,
	string context,
	bool useAsync
)

Parameters

control
Type: System.Web.UI.Control

The server Control that handles the client callback. The control must implement the ICallbackEventHandler interface and provide a RaiseCallbackEvent method.

argument
Type: System.String

An argument passed from the client script to the server

RaiseCallbackEvent method.

clientCallback
Type: System.String

The name of the client event handler that receives the result of the successful server event.

context
Type: System.String

The client script that is evaluated on the client prior to initiating the callback. The result of the script is passed back to the client event handler.

useAsync
Type: System.Boolean

true to perform the callback asynchronously; false to perform the callback synchronously.

Return Value

Type: System.String

The name of a client function that invokes the client callback.

Exception Condition
ArgumentNullException

The Control specified is null.

InvalidOperationException

The Control specified does not implement the ICallbackEventHandler interface.

This overload of the GetCallbackEventReference method requires a useAsync parameter, which allows you to perform the client callback asynchronously by setting the value to true. The overload versions of this method that do not require the useAsync parameter set the value to false by default.

For more information on this method, see the remarks for the overload GetCallbackEventReference method.

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft