Skip to end of metadata
Go to start of metadata

This topic describes the advanced features of ClientUI windowing framework and controls, and provides guidance to implement the advanced features in your applications. For information about the fundamental concepts and features of ClientUI windowing framework, see Window and Dialog Boxes Overview.

On this page:

Desktop, Window and Task Bar Integration

ClientUI windowing framework provides a set of comprehensive controls that lets you build rich multiple document interface (MDI) application with best design pattern available. The desktop and window controls are the main building block of an MDI application which is explained in Window and Dialog Boxes Overview.

Additionally, the desktop and window controls can be integrated to a task bar interface for even more compelling application. ClientUI windowing framework uses a loosely-coupled architecture that enables the desktop and window to integrate to an external task bar interface without knowing the actual type of the task bar. This eliminates the need to have a strong reference to the assembly that contains the actual task bar control. Consequently, this architecture enables better scalability and more future proof, as a variety of task bar controls can be used without code changes in the desktop and window.

The following sections describe the architecture overview of ClientUI windowing framework, and explains the important points you need to know to build rich applications using desktop, window and task bar integration.

Architecture Overview

The windowing components integration is thoughtfully engineered through the efficient use of the routed events, routed commands, routed input and focus scope. To learn more about these concepts, see ClientUI Fundamentals.

The following illustration describes the windowing framework architecture.

As seen in the above illustration, the UXDesktop class represents a container that acts as desktop manager, which manages the windows lifetime and connects the window to the taskbar.

A window is represented by a class that implements IWindow interface which is the basic requirement of a window to be managed by the desktop manager. Examples of window controls that implement the IWindow interface are , UXWindowChrome, UXDialogBox and UXNavigationWindow

A task bar is represented by a class that implements ITaskBar interface which is required for the desktop manager integration. In this release, you use UXDesktopDock control to implement the task bar interface that support desktop manager and window integration.

The most basic implementation to integrate a UXDesktop to a task bar such as UXDesktopDock is by specifying the target task bar instance to the TaskBar property of the UXDesktop. This can be done through element binding in XAML.

The following example shows a basic implementation of integration between the UXDesktop, UXWindow and UXDesktopDock.


Understanding Window Identity Concept and Its Relation with Task Bar Integration

There are several fundamental concepts that explain how the window and dock works, which you need to understand before implementing applications that take advantage of the windowing framework in ClientUI.

One of the key objectives of the integration architecture design in ClientUI windowing framework is to streamline rich MDI application development in a way that allows you to rapidly add new windows and then logically define the buttons to be associated to the windows in 1:1 mapping. This is a state-of-the-art implementation in ClientUI windowing framework that enables automatic status synchronization between the window and the task bar, which ultimately delivers consistent and reliable user experiences.

At the heart of the integration is the window identity concept that defines the uniqueness of a window. Each window that managed by the desktop manager should be unique, which is crucial in the desktop and task bar integration, particularly in the desktop manager logic to determine the relationship between a window and the task bar button that represents the window.

The identity of a window is determined through the following properties:

To make a window unique, you need to set at least one of the properties listed above. You can define more than one of the properties above, but you generally define the properties based on your scenarios, which is explained further in the following section.

The task bar queries the above properties when it needs to synchronize the buttons according to the windows status. For example, when a window is opened, the task bar button associated to it should be indicated as active. In more details, the task bar synchronization occurred during the following actions:

  • A window is opened from the task bar button.
  • A window is opened programmatically from API or command.
  • A window is closed by user, or through programmatically.
  • A window is minimized to the task bar.
  • A window is restored from the task bar.

Through the solid identity mapping concept described above, a task bar is capable to perform many functions automatically, without requiring you to write extra code or implementation. All you need is to define one or more of the properties above to create a unique identifier for your windows.

The following points describe the operations that performed automatically as the results of the relation between window identity and task bar implementation:

  • At first load, task bar buttons that represent the visible windows will be marked as active.
  • When a window is opened, the associated task bar button will be marked as active.
  • When a window is opened and there is no task bar button associated to the window, a task bar button will be created and added to the last position of the task bar. This condition is true if the window's ShowInTaskBar is set to true which is the default value. The dynamic task bar button automatically uses the icon specified in the IconLarge of the window, or the Icon property if the IconLarge property is not specified.
  • When a window is closed and the associated task bar button was previously existed when the window opened, the associated task bar button will be marked as inactive (the active indicator is removed). This condition is only true when there are no windows defined in the same group, which is identified through the GroupName property of the window.
  • When a window is closed and the associated task button was dynamically created by the desktop manager, the associated task bar button will be removed when the window is closed completely.
  • When a window is minimized, a button is dynamically added to the task bar which displays the live thumbnail of the last window content. The minimize button will be added after MinimizeButtonGroup property of the UXDesktopDock, if specified.
  • When a window has been minimized, clicking the associated task bar button will restore the minimized window instead of creating a new instance of the window.
  • Clicking the minimize button that was dynamically created will restore the minimized window.
  • When a window is restored, the dynamically created minimize button will be removed while the restore animation takes place.

For the above operations to work automatically as expected, you need to carefully implement and review the unique identifier for your window instances.
The following illustration shows the benefits of the relation between windows and buttons in the task bar such as described above.

Integration Scenarios and Examples

In the previous section, you have learned about the concept of window identity, and how it relates to the task bar interface in many ways. This section explains several scenarios that take advantage of the integration features, which can be found in typical business applications.

You implement the window identity based on the one of the scenarios described in the following sub sections.

Single Window Scenario

The simplest integration scenario is where a window is mapped in 1:1 to a button. In this scenario, you have a button that represents the window through its WindowName. Both the WindowName property of the button and the window should be identical, which is shown in the following example.

Multiple Windows (Group) Scenario

In certain cases, a button in the task bar can represent more than one window instances. For example, consider the Windows Explorer application in the Windows operation system where you can open several Windows Explorer instances, yet they are represented as one button in the task bar.

You can also achieve this kind of scenario in ClientUI windowing framework by specifying a value to the GroupName property of the windows having the same group, which is then mapped to the WindowGroupName of the task bar button.

The following example shows the XAML code to achieve multiple windows (group) scenario.


 When using this scenario, you may want to consider to pair it with dynamic window scenario which is explained in the following subsection.

Dynamic Window Scenario 

In a real world application, it is uncommon to show all windows during the application startup. You typically show a list of applications in the task bar (or shortcut) and allow users to launch the applications on demand. In this scenario, the window that associated to the application is dynamically created upon user's requests.

To open a window dynamically, you set the ApplicationUri of the button to the target URI of the physical XAML in your project. Using this technique, it is not necessary to define the window in the desktop manager since the dynamic window will be added to the desktop manager at runtime.

With ApplicationUri, the dynamically launched window will be automatically associated to the button in the task bar and the value of the ApplicationUri becomes the unique identifier that differentiate it from the other windows. The similar mechanism is applied to NavigateUri property of the button. When specified, the target XAML will be launched in a new UXNavigationWindow instance instead of UXWindow.

 The main difference of the ApplicationUri and NavigateUri concept is that the ApplicationUri is best paired with target XAML that encapsulates a window such as UXWindow or UXDialogBox, while the NavigateUri is best paired with target XAML that encapsulates a page such as UXPage. To learn more about navigation window, see UXNavigationWindow Overview.
The following illustration shows the dynamic windows that are associated to buttons through ApplicationUri and NavigateUri property.

The following example shows the XAML that encapsulates a window and its content.


The following example shows the page that contains the desktop and task bar button which opens the window in the previous example through the ApplicationUri definition.


For the guided walkthrough to implement desktop-style (MDI) application, see Walkthrough: Create Rich Application using Windowing and MVVM Pattern.

ClientUI provides project and item templates that let you rapidly develop desktop-style (MDI) application using Visual Studio 2010. To learn more about the project and item templates installed with ClientUI, see Introduction to ClientUI Project Templates.

Dynamic Window with Application Integration Scenario

In addition to physical XAML in the same project, you can also open a window of which its XAML is physically located in a different application package (.xap). This is a fundamental architecture to build composite applications that capable to load applications that are typically made available on demand, and then inject its content to the main application as if the content was physically existed in the main application.

ClientUI provides a powerful application framework that allows you to build scalable composite applications with key features such as on-demand downloading, integration with navigation, as well as integration with windowing framework.

For more information about creating dynamic windowing application that integrates to application framework, see Application Framework Overview.

Using Window Commands and Window Options

The ClientUI windowing framework does not only provide rich windowing controls that you can use to create compelling MDI applications, it also provides solid architecture that thoughtfully engineered to enable you easily achieve windowing tasks commonly found in line-of-business applications, for instances, open a window with preconfigured properties and passing parameters using commanding pattern. This pattern also allows you to address a variety of UI challenges in more elegant way through the efficient use of MVVM pattern. For more information about commanding, see Commanding Overview. For information about MVVM pattern development, see MVVM Pattern Overview.

ClientUI windowing framework provides a number of pre-implemented windowing commands that you can consume directly such as LaunchApplication, Close, SetActive and more. To learn more about the commands available in ClientUI windowing framework, see Window and Dialog Boxes Overview.

This section describes how to use LaunchApplication command to perform a number of windowing-related tasks which are explained in the following sub sections.

Open a Window Based on Target URI

To open a window based on the target URI, you use the LaunchApplication command and set the value of the CommandParameter property in the particular command source (such as UXButton) to the target URI the window to be opened.

The following example shows how to open a window based on the given URI using command.


 Although the target URI can be any XAML that contains supported Silverlight content type such as UserControl, the LaunchApplication command is best used to target a XAML file that encapsulates a UXWindow, or a UXPage.

Open a Window With Preconfigured Options

In certain cases, you may want to open a window with certain settings applied, such as the window width, window height, title, and icon. Often times, you may also want to pass custom data as parameter to the window being opened. You can use WindowOptions to achieve many of these tasks. The WindowOptions is a DependencyObject, which means you can instantiate this class in the XAML and bind it to the CommandParameter of a command source.

Understanding WindowOptions

WindowOptions class provides numerous properties that you can set to preconfigure a window when used with LaunchApplication command, which is described in the folllowng list.

  • Uri
    Specifies the target URI of the window to be opened, which is required for the LaunchApplication command to work properly.
  • ForceSingleInstance
    When set to true, the window will be opened only if there are no existing windows with identical window identifier. For instance, if there is a window that associated to Notepad.xaml in the desktop, the command will no longer open the window that target Notepad.xaml.
  • NavigationBarVisibility
    By default, opening a new UXNavigationWindow will show the navigation bar element. You can hide the navigation bar in certain cases without have to change the settings in the existing navigation window by specifying the NavigationBarVisibility property of the window options to Collapse.
  • ReactivateExistingInstance
    This property works in conjunction with the ForceSingleInstance property. When set to true, the existing window that matches the identity of the target window will be activated if it is currently in inactive state, or restored if it is currently in minimize state.
  • StartupParameters
    Specifies the custom data to be passed as startup parameters for the target window. The data that passed in this property can be obtained from the StartupParameters property of the window during the Loaded event of the window. Alternatively, you can also access the custom data during the Launched event, which is a bubbling routed event raised by the UXDesktop upon successful window launch.
  • UID
    Specifies the unique identifier for the target window. In most cases, you do not need to specify this property manually as the windowing framework can assign the unique identifier automatically.
  • WindowName
    Specifies the name of the target window, which overrides the WindowName property of the window.
  • WindowGroupName
    Specifies the group name of the target window, which overrides the GroupName property of the window.
  • WindowWidth
    Specifies the width of the target window, which overrides the Width property of the window.
  • WindowHeight
    Specifies the width of the target window, which overrides the Height property of the window.
  • WindowTitle
    Specifies the title of the target window, which overrides the Header property of the window.
  • WindowIcon
    Specifies the icon of the target window, which overrides the Icon property of the window.

The settings specified in the WindowOptions has higher precedence than the default settings of the window. This means that the settings specified in WindowOptions will override the settings defined in the window.


The following example shows how to open a window based on a target URI using command.


The following example shows how to open a window and pass a custom data to the startup parameter, then obtain the passed data in the target window in Loaded event.


 Since the StartupParameters is a dependency property, you can also pass complex data through data binding, for example, binding to the selected item in a list box. This allows you to use MVVM pattern in conjunction with the commanding. To learn more about using MVVM pattern in UI development, see MVVM Pattern Overview.
The following example shows how to open a window that target a URI with single instance option, and automatically activate the existing instance if found.


The following example shows how to open a window with customized size, title and icon.


Managing Busy State

The UXWindow control provides built-in busy state management allowing you to create compelling window interface that responsive to user interactions. To set a window as busy, you simply set the IsBusy property to true. In addition, ClientUI also provides similar features for other frameworks such as navigation. To learn more about navigation framework, see Navigation Overview.

Busy Behaviors

The windowing controls in ClientUI implement many user experience features that conform to ISO Standards 9241, such as the behaviors for busy indicator.

When you set a window as busy and its BlockUIOnBusy property is enabled, you can notice the following behaviors:

  • The user interaction on the window will be blocked. This means that users can not click on the content of the window or type into the window during the busy mode.
  • The cursor will appear as wait (hour glass), which is applied only to the region of the particular window.
  • The custom busy indicator will be displayed, when defined.

The following figure shows an example of a window in busy mode.

When a window is set as busy, the other windows in the desktop can continue to receive user interactions. This simulates a multi-threading operation similar to Windows operating system. As in above example, you can click on the UXWindow1 or UXWindow2, while the DetailsWindow is busy.

To learn more about user experience features implemented in ClientUI controls, see User Experiences Overview.

Customizing Busy Template

While processing a long running operation, such as in report generation and asynchronous data retrieval scenario, you may want to show a customized busy indicator in addition to the built-in behaviors described in the previous section.

You can add your own busy indicator to be displayed when the window is busy by setting your custom XAML template to the BusyIndicatorTemplate property of the window.

The following example shows how to setup the UXWindow to show a progress bar when the window is busy. This is done by specifying a custom data template to the BusyIndicatorTemplate property.


The result looks like the following illustration.


Related Topics

There is no content with the specified labels