XafApplication.CreateCustomTemplate Event

Occurs when creating a Template.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v24.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public event EventHandler<CreateCustomTemplateEventArgs> CreateCustomTemplate

VB.NET

Public Event CreateCustomTemplate As EventHandler(Of CreateCustomTemplateEventArgs)

Event Data

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

Property	Description
Application	Provides access to the XafApplication object.
Context	Returns the context in which a Template is created.
Template	Specifies the Template which is created in a XafApplication.CreateCustomTemplate event handler.
UseDefaultTemplate	Defines whether the application creates default templates on startup.

Remarks

In Windows Forms applications, this event is raised when a Window is created. Handle this event to create a custom Template for this Window. For this purpose, use the handler’s CreateCustomTemplateEventArgs.Context parameter to create a custom Template for a particular context. For details, refer to the Template Customization, How to: Create a Custom WinForms Ribbon Template and How to: Create a Custom WinForms Standard Template topics.

In ASP.NET Web Forms applications, Templates represent pages that implement the IFrameTemplate or IWindowTemplate interface. If a page which is being loaded does not implement one of these interfaces, the CreateCustomTemplate event is raised. Handle this event, to create a Web control that implements the IFrameTemplate or IWindowTemplate interface.

The CreateCustomTemplate event is triggered at an XAF WinForms application’s startup, once or twice. This depends on the conditions below.

	When the Event is Triggered	When to Handle the Event
1	On the application’s startup, before the Application Model loads.	To create custom Logon or Main Window templates that do not require the Application Model. If you handle the event at this time, the application creates templates in a separate thread and demonstrates a reduced startup time.
2	On the application’s startup, after the Application Model loads - if no custom templates were passed the first time the event was triggered.	To get Logon or Main Window templates created the first time the event was triggered or to create templates that depend on the Application Model for their settings.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CreateCustomTemplate event.

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.Win/Program.cs#L26

InfoPanelsWindowsFormsApplication winApplication = new InfoPanelsWindowsFormsApplication();
winApplication.CreateCustomTemplate += winApplication_CreateCustomTemplate;
DevExpress.ExpressApp.Xpo.InMemoryDataStoreProvider.Register();

VB.NET

xaf-how-to-create-information-panels/VB/InfoPanels.Win/Program.vb#L28

Dim winApplication As New InfoPanelsWindowsFormsApplication()
AddHandler winApplication.CreateCustomTemplate, AddressOf winApplication_CreateCustomTemplate
DevExpress.ExpressApp.Xpo.InMemoryDataStoreProvider.Register()