ProgressIndicator
A ProgressIndicator control shows the user that a component in a SPEAK page has made a request and is waiting for a response. It does this by displaying an animated graphic. You can specify if this graphic overlays only a specific control or the whole page. Users cannot interact with controls that are overlaid by a ProgressIndicator control.
The ProgressIndicator control is often used when a SPEAK component interacts with the backend server. For example, you often create “search pages” with this pattern:
- You use a SearchDataSource component to retrieve items
- You use a ListControl component to show the items
To show users when a search is in progress, you must:
- Add a ProgressIndicator control to your page
- Set the TargetControl property of the ProgressIndicator control to the ListControl component
- Bind the IsBusy property of the ProgressIndicator control to the IsBusy member of the SearchDataSource component
Properties
| Name | Description | Default |
|---|---|---|
| Appearance | ||
| Delay | Specify the delay in milliseconds before the ProgressIndicator control appears. | 400 ms |
| IsBusy | If true, SPEAK shows the ProgressIndicator control. | False |
| IsFullscreen | If true, the ProgressIndicator control covers the whole SPEAK page. | False |
| Data | ||
| AutoShow | If True, SPEAK shows the ProgressIndicator control automatically when a UI element makes a request and this request takes longer than a specific amount of time to conclude. | |
| AutoShowTimeout | Specify an amount of time (in milliseconds) that SPEAK waits before it shows the ProgressIndicator control. This requires that the AutoShow property is true. |
Configuration
You can create a configuration item for a ProgressIndicator control by creating an item based on the ProgressIndicator template.
The configuration item has these specific fields:
- IsFullscreen
- Delay
- IsBusy
- TargetControl
- AutoShow
- AutoShowTimeout
It inherits these fields:
- IsVisible
- AccessKey
- Tooltip
- Behaviors
- Id