Skip to end of metadata
Go to start of metadata

UXBusyIndicator is a lightweight content control with built-in busy indicator display. It comes with a predefined, modern spinner-style loading indicator suitable for use in typical business applications.

UXBusyIndicator includes a number of time-saving features that supports common busy indicator scenarios, such as using the control to block the existing content when busy, show an overlay, or hide the existing content.

On this page:

Content Control

UXBusyIndicator is inherited from ISContentControl, which means that it can contain a single object of any types, such as a string, an image, or a panel. For more information about content model, see Content Model Overview.

Using UXBusyIndicator

You use UXBusyIndicator control to provide an easy way to show a busy visual hint on top of the content when the application is in progress executing a long running task, such as retrieving data, logging in, or saving a record.

The UXBusyIndicator is designed as a content control, this means that you generally put the content inside the control, such as shown in the following example.

XAML

Setting Busy Mode and Adding Busy Content

UXBusyIndicator displays a busy visual hint when the control is busy, which is done by setting the IsBusy property to true. You can also easily add a custom content to the busy indicator, such as showing a "Loading..." text, or other content that suitable to your application's context.

The following example shows how to add a text to the busy content and set the busy mode in Button .Click event.

XAML
C#

The IsBusy property is a dependency property, which means that you can bind it to a property in the ViewModel using MVVM design pattern. This allows you to set the busy mode from the user interaction logic in the ViewModel, track the notification and give feedback as a response. 

For more information on building Silverlight and WPF application with MVVM design pattern, see MVVM Pattern Overview.

In addition to customizing the busy content, there are several layout-related properties that you can configure such as the busy content placement position and the busy content margin. These properties provides an easy way for you to customize common settings without requiring control re-templating. By default, the busy content appears below the busy indicator, which is controlled through the BusyContentPlacement property, while the item spacing between the indicator and the content is controlled through the BusyContentMargin property.

Blocking Content When Busy

One of the useful features in UXBusyIndicator is the ability to block the content from user interaction when the control is in busy state. This feature is enabled by default, which can be disabled by setting the BlockUIOnBusy property to false.

When enabled, UXBusyIndicator automatically disable the content and show an overlay on the top of the content which gives impression to users that the content cannot be accessed.

The overlay is set to a semi-transparent radial gradient background which is ideal for typical business applications. You can easily customize the background brush by setting the OverlayBackground property. In addition, you can provide more comprehensive styling to the overlay element by specifying a style to the OverlayStyle property.

The following illustration shows the UXBusyIndicator with a customized overlay background.

The IsBusy property is a dependency property, which means that you can bind it to a property in the ViewModel using MVVM design pattern. This allows you to set the busy mode from the user interaction logic in the ViewModel, track the notification and give feedback as a response. 

For more information on building Silverlight and WPF application with MVVM design pattern, see MVVM Pattern Overview.

In addition to customizing the busy content, there are several layout-related properties that you can configure such as the busy content placement position and the busy content margin. These properties provides an easy way for you to customize common settings without requiring control re-templating. By default, the busy content appears below the busy indicator, which is controlled through the BusyContentPlacement property, while the item spacing between the indicator and the content is controlled through the BusyContentMargin property.

Blocking Content When Busy

One of the useful features in UXBusyIndicator is the ability to block the content from user interaction when the control is in busy state. This feature is enabled by default, which can be disabled by setting the BlockUIOnBusy property to false.

When enabled, UXBusyIndicator automatically disable the content and show an overlay on the top of the content which gives impression to users that the content cannot be accessed.

The overlay is set to a semi-transparent radial gradient background which is ideal for typical business applications. You can easily customize the background brush by setting the OverlayBackground property. In addition, you can provide more comprehensive styling to the overlay element by specifying a style to the OverlayStyle property.

The following illustration shows the UXBusyIndicator with a customized overlay background.

In this mode, the content will show back when the value of the IsBusy property is set to false.

Customizing Busy Latency

In many cases, data processing or application tasks may complete faster than expected. The performance varies on a number of factors such as hardware configuration, network speed, and more. In a good sense of user experience, you may want to display the busy indicator only after a certain timespan has ellapsed, for instance, after two seconds. This technique also reduces screen flickering which may occur when the busy indicator is displayed and then hidden in short timespan.

UXBusyIndicator introduces busy latency, a feature that allows you to set the timespan to wait before the busy indicator is displayed, when the IsBusy property changes to true. The default value for the busy latency is one second, which you can customize through the BusyLatency property.

The following example shows how to customize the timespan of the busy latency to two seconds.

XAML

Handling UXBusyIndicator Events

UXBusyIndicator provides IsBusyChanged event which occurs when the IsBusy property changes. The IsBusyChanged is a routed event with bubbling strategy, which means that you can flexibly handling the event anywhere in the tree node. For more information on handling a routed event, see How to: Handle a Routed Event. For more information about routed event concept, see Routed Events Overview.

Customizing Busy Indicator Template

UXBusyIndicator includes a predefined busy indicator that shows a modern indeterminate spinner design. While this design suits to just any application types, you may often run into a scenario where you need to use other type of busy indicators, such as a progress bar.

You can easily completely replace the default busy indicator with your own custom indicator design by providing a custom data template to the BusyIndicatorTemplate property.

The following example shows how to customize the indicator template of the UXBusyIndicator control which uses a UXProgressBar to show an indeterminate progress.

XAML

The result looks like the illustration in the following.

Customizing UXBusyIndicator Appearance

You can easily customize the UXBusyIndicator appearance through the following properties.

  • Background
  • BorderBrush
  • BorderThickness
  • CornerRadius
  • Foreground
  • OverlayBackground
  • OverlayStyle

If you would like to completely customize the control appearance or if you want to change the styles of each visual state, you can edit the template of the control and do the modification accordingly.

To learn more how to customize the template and visual states, see Styles and Template Overview.

Walkthroughs and Samples

For the list of ClientUI walkthroughs, see Walkthroughs and How-to Topics.

For the list of ClientUI samples available in local installation, see Locating the Samples in Local Installation.

 

Related Topics