SupportClientScriptsExtensions.SetClientScript(ISupportClientScripts, String, Boolean) Method
Assigns a JavaScript code to the current Action. This code is executed in a browser when a user clicks the Action.
Namespace: DevExpress.ExpressApp.Actions
Assembly: DevExpress.ExpressApp.Web.v24.2.dll
NuGet Package: DevExpress.ExpressApp.Web
#Declaration
public static void SetClientScript(
this ISupportClientScripts action,
string script,
bool processOnServer
)
#Parameters
Name | Type | Description |
---|---|---|
action | DevExpress. |
An ISupport |
script | String | A string specifying the Java |
process |
Boolean | true, if the Action should be processed on the server in addition to the Java |
#Remarks
Use this overload to assign a custom script to a specified Action. The processOnServer parameter controls whether the Action’s default code is processed on the server.
process |
Special conditions | Result |
---|---|---|
true | - | When an end user clicks a specified Action, the custom script is executed on the client-side, and then the Action’s default code is executed on the server. |
true | The client script also returns true. | When an end user clicks a specified Action, the custom script is executed on the client-side. The server does not process the Action’s default code. |
false | - | When an end user clicks a specified Action, the custom script is executed on the client-side. The server does not process the Action’s default code. |
The following example demonstrates how you can use the SetClientScript method in your code.
using System.Web;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.Persistent.Base;
// ...
public class SampleController : ViewController {
public SampleController() {
SimpleAction action =
new SimpleAction(this, "ActionWithScript", PredefinedCategory.Edit);
action.SetClientScript(string.Format
("alert('About to execute the {0} action.');",
HttpUtility.JavaScriptStringEncode(action.Caption)), false);
}
}