WebWindow.CustomRegisterTemplateDependentScripts Event

Occurs when ASP.NET Web Forms Template’s scripts are registered.

Namespace: DevExpress.ExpressApp.Web

Assembly: DevExpress.ExpressApp.Web.v24.2.dll

NuGet Package: DevExpress.ExpressApp.Web

Declaration

C#

public event EventHandler<CustomRegisterTemplateDependentScriptsEventArgs> CustomRegisterTemplateDependentScripts

VB.NET

Public Event CustomRegisterTemplateDependentScripts As EventHandler(Of CustomRegisterTemplateDependentScriptsEventArgs)

Event Data

The CustomRegisterTemplateDependentScripts event's data class is DevExpress.ExpressApp.Web.CustomRegisterTemplateDependentScriptsEventArgs.

Remarks

Handle the CustomRegisterTemplateDependentScripts to register custom scripts. The snippet below illustrates how to implement the Controller that subscribes to this event.

C#

public class RegisterCustomScriptsController : Controller {
    private void window_CustomRegisterTemplateDependentScripts(
        object sender, CustomRegisterTemplateDependentScriptsEventArgs e) {
        WebWindow window = (WebWindow)sender;
        e.Handled = true;
        e.Page.ClientScript.RegisterClientScriptResource(GetType(), 
            "MySolution.Module.Web.Resources.TemplateScripts.js");
        e.Page.ClientScript.RegisterClientScriptResource(GetType(), 
            "MySolution.Module.Web.Resources.MoveFooter.js");
    }
    protected override void OnFrameAssigned() {
        base.OnFrameAssigned();
        WebWindow window = Frame as WebWindow;
        if(window != null) {
            window.CustomRegisterTemplateDependentScripts += 
                new EventHandler<CustomRegisterTemplateDependentScriptsEventArgs>(
                    window_CustomRegisterTemplateDependentScripts);
        }
    }
    protected override void OnDeactivated() {
        WebWindow window = Frame as WebWindow;
        if(window != null) {
            window.CustomRegisterTemplateDependentScripts -= 
                new EventHandler<CustomRegisterTemplateDependentScriptsEventArgs>(
                    window_CustomRegisterTemplateDependentScripts);
        }
        base.OnDeactivated();
    }
}

VB.NET

Public Class RegisterCustomScriptsController
    Inherits Controller
    Private Sub window_CustomRegisterTemplateDependentScripts( _
    ByVal sender As Object, ByVal e As CustomRegisterTemplateDependentScriptsEventArgs)
        Dim window As WebWindow = CType(sender, WebWindow)
        e.Handled = True
        e.Page.ClientScript.RegisterClientScriptResource( _
        Me.GetType(), "FeatureCenter.Module.Web.Resources.TemplateScripts.js")
        e.Page.ClientScript.RegisterClientScriptResource( _
        Me.GetType(), "FeatureCenter.Module.Web.Resources.MoveFooter.js")
    End Sub
    Protected Overrides Sub OnFrameAssigned()
        MyBase.OnFrameAssigned()
        Dim window As WebWindow = TryCast(Frame, WebWindow)
        If window IsNot Nothing Then
            AddHandler window.CustomRegisterTemplateDependentScripts, _
            AddressOf window_CustomRegisterTemplateDependentScripts
        End If
    End Sub
    Protected Overrides Sub OnDeactivated()
        Dim window As WebWindow = TryCast(Frame, WebWindow)
        If window IsNot Nothing Then
            RemoveHandler window.CustomRegisterTemplateDependentScripts, _
            AddressOf window_CustomRegisterTemplateDependentScripts
        End If
        MyBase.OnDeactivated()
    End Sub
End Class

The complete example is available in the FeatureCenter demo.