WebWindow.RegisterStartupScript(String, String, Boolean) Method

Registers the startup 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.2.dll

NuGet Package: DevExpress.ExpressApp.Web

Declaration

C#

public void RegisterStartupScript(
    string scriptName,
    string script,
    bool overwrite
)

VB.NET

Public Sub RegisterStartupScript(
    scriptName As String,
    script As String,
    overwrite As Boolean
)

Parameters

Name	Type	Description
scriptName	String	A string containing the name of the startup script to register.
script	String	A string containing the startup script literal to register.
overwrite	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.

The following topic shows how to use this method: How to: Print a Report Without Displaying a Preview.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RegisterStartupScript(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-how-to-create-information-panels/CS/InfoPanels.Web/MyDefaultVerticalTemplateContent.ascx.cs#L28

private void CurrentRequestWindow_PagePreRender(object sender, EventArgs e) {
    WebWindow.CurrentRequestWindow.RegisterStartupScript("OnLoadCore", string.Format(@"Init(""{0}"", ""VerticalCS"");OnLoadCore(""LPcell"", ""separatorCell"", ""separatorImage"", true, true);", BaseXafPage.CurrentTheme), true);
    UpdateTRPVisibility();

xaf-print-a-report-without-displaying-a-preview/CS/InstantPrintReportsV2Example.Module.Web/Controllers/WebInstantPrintReportController.cs#L14

string reportContainerHandle = ReportDataProvider.ReportsStorage.GetReportContainerHandle(reportData);
((WebWindow)WebApplication.Instance.MainWindow).RegisterStartupScript(
    "InstantPrintReport", GetPrintingScript(reportContainerHandle), overwrite: true);

VB.NET

xaf-how-to-create-information-panels/VB/InfoPanels.Web/MyDefaultVerticalTemplateContent.ascx.vb#L30

Private Sub CurrentRequestWindow_PagePreRender(ByVal sender As Object, ByVal e As EventArgs)
    WebWindow.CurrentRequestWindow.RegisterStartupScript("OnLoadCore", String.Format("Init(""{0}"", ""VerticalCS"");OnLoadCore(""LPcell"", ""separatorCell"", ""separatorImage"", true, true);", BaseXafPage.CurrentTheme), True)
    UpdateTRPVisibility()

xaf-print-a-report-without-displaying-a-preview/VB/InstantPrintReportsV2Example.Module.Web/Controllers/WebInstantPrintReportController.vb#L16

    Dim reportContainerHandle As String = ReportDataProvider.ReportsStorage.GetReportContainerHandle(reportData)
    CType(WebApplication.Instance.MainWindow, WebWindow).RegisterStartupScript("InstantPrintReport", GetPrintingScript(reportContainerHandle), overwrite:= True)
End Sub