XafApplication.CustomizeTemplate Event

Occurs after a Template has been created.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public event EventHandler<CustomizeTemplateEventArgs> CustomizeTemplate

VB.NET

Public Event CustomizeTemplate As EventHandler(Of CustomizeTemplateEventArgs)

Event Data

The CustomizeTemplate event's data class is CustomizeTemplateEventArgs. The following properties provide information specific to this event:

Property	Description
Context	Returns the context in which the Template to be customized was created.
Template	Provides access to the Template to be customized.

Remarks

Handle this event to customize a particular template. Use the handler’s CustomizeTemplateEventArgs.Context or CustomizeTemplateEventArgs.Template parameter. For more information, refer to the following topics:

• Template Customization
• How to: Access the Navigation Control.

The following code snippet demonstrates how to handle the CustomizeTemplate event to hide toolbars that accompany a nested List View in ASP.NET Core Blazor and Windows Forms XAF applications:

C#

using DevExpress.ExpressApp.Templates;
//...
public class MyHideToolbarController : Controller {
    protected override void OnActivated() {
        base.OnActivated();
        Application.CustomizeTemplate += Application_CustomizeTemplate;
    }
    void Application_CustomizeTemplate(object sender, CustomizeTemplateEventArgs e) {
        if (e.Context == TemplateContext.NestedFrame) {
            ISupportActionsToolbarVisibility template = 
                e.Template as ISupportActionsToolbarVisibility;
            if (template != null) template.SetVisible(false);
        }
    }
    protected override void OnDeactivated() {
        Application.CustomizeTemplate -= Application_CustomizeTemplate;
        base.OnDeactivated();
    }
}

VB.NET

Imports DevExpress.ExpressApp.Templates
'...
Public Class MyHideToolbarController
    Inherits Controller
    Protected Overrides Sub OnActivated()
        MyBase.OnActivated()
        AddHandler Application.CustomizeTemplate, AddressOf Application_CustomizeTemplate
    End Sub
    Private Sub Application_CustomizeTemplate(ByVal sender As Object, _
    ByVal e As CustomizeTemplateEventArgs)
        If e.Context = TemplateContext.NestedFrame Then
            Dim template As ISupportActionsToolbarVisibility = _
            TryCast(e.Template, ISupportActionsToolbarVisibility)
            If template IsNot Nothing Then
                template.SetVisible(false)
            End If
        End If
    End Sub
    Protected Overrides Sub OnDeactivated()
        RemoveHandler Application.CustomizeTemplate, AddressOf Application_CustomizeTemplate
        MyBase.OnDeactivated()
    End Sub
End Class

In Windows Forms applications, this event is raised after XAF creates a Template and before the template is assigned to a Window.

For instructions on how to customize a template in an ASP.NET Web Forms application, refer to the following topic: How to: Customize an ASP.NET Web Forms Template.