SupportClientScriptsExtensions.SetClientScript(ISupportClientScripts, String) 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.1.dll

NuGet Package: DevExpress.ExpressApp.Web

Declaration

C#

public static void SetClientScript(
    this ISupportClientScripts action,
    string script
)

VB.NET

<ExtensionAttribute>
Public Shared Sub SetClientScript(
    action As ISupportClientScripts,
    script As String
)

Parameters

Name	Type	Description
action	DevExpress.ExpressApp.Actions.ISupportClientScripts	An ISupportClientScript object specifying an Action.
script	String	A string specifying the JavaScript code to be executed when a user clicks the current Action.

Remarks

Use this overload to assign a custom script to a specified Action. The overload executes the SetClientScript(ISupportClientScripts, String, Boolean) method with true as the processOnServer parameter.

When a user clicks the specified Action, the custom script is executed on the client side, and then the Action’s default code is executed on the server. If the custom script returns true, the script is executed on the client side, but the server does not process the Action’s default code.

The following example demonstrates how you can use the SetClientScript method in your code.

C#

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)));
  }
}

VB.NET

Imports System.Web
Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Actions
Imports DevExpress.Persistent.Base
' ...
Public Class SampleController
  Inherits ViewController
  Public Sub New()
    Dim action As New SimpleAction(Me, "ActionWithScript", _
      PredefinedCategory.Edit)
    action.SetClientScript(String.Format _
      ("alert('About to execute the {0} action.');",
      HttpUtility.JavaScriptStringEncode(action.Caption)))
  End Sub
End Class