WindowTemplateController Class

Allows you to update the current Window status messages and caption.

Namespace: DevExpress.ExpressApp.SystemModule

Assembly: DevExpress.ExpressApp.v26.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public class WindowTemplateController :
    WindowController

VB.NET

Public Class WindowTemplateController
    Inherits WindowController

Remarks

XAF activates WindowTemplateController in all Windows. The controller exposes two public events that you can use to customize the Window’s status message and caption:

• CustomizeWindowCaption - allows you to customize the Window’s caption
• CustomizeWindowStatusMessages - allows you to customize the Window’s status message

The following code snippet specifies a custom caption and replaces the default status message in an XAF Windows Forms application:

MySolution.Win\Controllers\CustomizeWindowController.cs

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.SystemModule;

namespace MySolution.Win.Controllers;

public class CustomizeWindowController : WindowController {
    public CustomizeWindowController() { }

    protected override void OnActivated() {
        base.OnActivated();
        WindowTemplateController controller = Frame.GetController<WindowTemplateController>();
        controller.CustomizeWindowCaption += Controller_CustomizeWindowCaption;
        controller.CustomizeWindowStatusMessages += Controller_CustomizeWindowStatusMessages;
    }

    private void Controller_CustomizeWindowCaption(object sender,
    CustomizeWindowCaptionEventArgs e) {
        e.WindowCaption.Text = "My Custom Caption";
    }

    private void Controller_CustomizeWindowStatusMessages(object sender,
    CustomizeWindowStatusMessagesEventArgs e) {
        e.StatusMessages.Clear();
        e.StatusMessages.Add("My Custom Status Message");
    }

    protected override void OnDeactivated() {
        base.OnDeactivated();
        WindowTemplateController controller = Frame.GetController<WindowTemplateController>();
        controller.CustomizeWindowCaption -= Controller_CustomizeWindowCaption;
        controller.CustomizeWindowStatusMessages -= Controller_CustomizeWindowStatusMessages;
    }
}

You can use the UpdateWindowCaption and UpdateWindowStatusMessage() methods to refresh the window caption and status messages when required.

For more examples and detailed information about window captions and status messages, refer to the following topics:

• How to Customize Window Captions in XAF Applications
• Window Status Messages in XAF WinForms Applications

Implements

ISupportUpdate

Inheritance

Object

MarshalByRefObject

Component

Controller

WindowController

WindowTemplateController