WindowTemplateController.UpdateWindowStatusMessage() Method

Refreshes the status bar messages.

Namespace: DevExpress.ExpressApp.SystemModule

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

C#

public void UpdateWindowStatusMessage()

VB.NET

Public Sub UpdateWindowStatusMessage

Remarks

Below is the example of using this method in a custom View Controller. This controller adds a status message that contains the selected objects count, by handling the WindowTemplateController.CustomizeWindowStatusMessages event. The UpdateWindowStatusMessage method is invoked in the ListEditor.SelectionChanged event handler, to refresh the status message when end-user changes the selection.

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.SystemModule;
// ...
public class UpdateWindowStatusMessagesController : ViewController<ListView> {
    private WindowTemplateController windowTemplateController;
    public UpdateWindowStatusMessagesController() {
        TargetViewNesting = Nesting.Root;
    }
    protected override void OnActivated() {
        base.OnActivated();
        windowTemplateController = Frame.GetController<WindowTemplateController>();
        if (windowTemplateController != null) {
            windowTemplateController.CustomizeWindowStatusMessages += 
                windowTemplateController_CustomizeWindowStatusMessages;
        }
    }
    protected override void OnViewControlsCreated() {
        base.OnViewControlsCreated();
        View.Editor.SelectionChanged += Editor_SelectionChanged;
    }
    protected override void OnDeactivated() {
        View.Editor.SelectionChanged -= Editor_SelectionChanged;
        if (windowTemplateController != null) {
            windowTemplateController.CustomizeWindowStatusMessages -= 
                windowTemplateController_CustomizeWindowStatusMessages;
            windowTemplateController.UpdateWindowStatusMessage();
        }
        base.OnDeactivated();
    }
    void windowTemplateController_CustomizeWindowStatusMessages(
        object sender, CustomizeWindowStatusMessagesEventArgs e) {
        e.StatusMessages.Add(
            String.Format("Selected objects count: {0}", View.SelectedObjects.Count));
    }
    void Editor_SelectionChanged(object sender, EventArgs e) {
        windowTemplateController.UpdateWindowStatusMessage();
    }
}

VB.NET

Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.SystemModule
' ...
Public Class UpdateWindowStatusMessagesController
    Inherits ViewController(Of ListView)

    Private windowTemplateController As WindowTemplateController
    Public Sub New()
        TargetViewNesting = Nesting.Root
    End Sub
    Protected Overrides Sub OnActivated()
        MyBase.OnActivated()
        windowTemplateController = Frame.GetController(Of WindowTemplateController)()
        If windowTemplateController IsNot Nothing Then
            AddHandler windowTemplateController.CustomizeWindowStatusMessages, AddressOf windowTemplateController_CustomizeWindowStatusMessages
        End If
    End Sub
    Protected Overrides Sub OnViewControlsCreated()
        MyBase.OnViewControlsCreated()
        AddHandler View.Editor.SelectionChanged, AddressOf Editor_SelectionChanged
    End Sub
    Protected Overrides Sub OnDeactivated()
        RemoveHandler View.Editor.SelectionChanged, AddressOf Editor_SelectionChanged
        If windowTemplateController IsNot Nothing Then
            RemoveHandler windowTemplateController.CustomizeWindowStatusMessages, AddressOf windowTemplateController_CustomizeWindowStatusMessages
            windowTemplateController.UpdateWindowStatusMessage()
        End If
        MyBase.OnDeactivated()
    End Sub
    Private Sub windowTemplateController_CustomizeWindowStatusMessages(ByVal sender As Object, ByVal e As CustomizeWindowStatusMessagesEventArgs)
        e.StatusMessages.Add(String.Format("Selected objects count: {0}", View.SelectedObjects.Count))
    End Sub
    Private Sub Editor_SelectionChanged(ByVal sender As Object, ByVal e As EventArgs)
        windowTemplateController.UpdateWindowStatusMessage()
    End Sub
End Class