WebWindow.RegisterClientScript(String, String, Boolean) Method

Registers the client script with the WebWindow‘s page, using the specified script name and script literal, and adds script tags. Optionally overrides existing script literals.

Namespace: DevExpress.ExpressApp.Web

Assembly: DevExpress.ExpressApp.Web.v23.1.dll

NuGet Package: DevExpress.ExpressApp.Web

Declaration

C#

public void RegisterClientScript(
    string scriptName,
    string script,
    bool overrideScript
)

VB.NET

Public Sub RegisterClientScript(
    scriptName As String,
    script As String,
    overrideScript As Boolean
)

Parameters

Name	Type	Description
scriptName	String	A string containing the name of the client script to register.
script	String	A string containing the client script literal to register.
overrideScript	Boolean	true, to override already registered script literals that use the same name; otherwise, false.

Remarks

When this method is called, the specified script name and literal are stored in an intermediate collection. When the page’s PreRender event occurs, the ClientScriptManager.RegisterClientScriptBlock method is invoked for each name/literal pair stored in the intermediate collection, for the Window’s page.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RegisterClientScript(String, String, Boolean) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

xaf-web-forms-use-oauth2-authentication-providers/CS/MySolution.Module.Web/Controllers/LogonAuthController.cs#L67

private void RegisterVisibleUserExistingTextScript(bool visible) {
    ((WebWindow)Frame).RegisterClientScript("LogonActionActive",
                string.Format("SetVisibleUserExistingText({0});", ClientSideEventsHelper.ToJSBoolean(visible)), true);

VB.NET

xaf-web-forms-use-oauth2-authentication-providers/VB/MySolution.Module.Web/Controllers/LogonAuthController.vb#L69

Private Sub RegisterVisibleUserExistingTextScript(ByVal visible As Boolean)
    CType(Frame, WebWindow).RegisterClientScript("LogonActionActive", String.Format("SetVisibleUserExistingText({0});", ClientSideEventsHelper.ToJSBoolean(visible)), True)
End Sub