Progress​Ring Progress​Ring Progress​Ring Progress​Ring Class

Definition

Represents a control that indicates that an operation is ongoing. The typical visual appearance is a ring-shaped "spinner" that cycles an animation as progress continues.

public : sealed class ProgressRing : Control, IProgressRingpublic sealed class ProgressRing : Control, IProgressRingPublic NotInheritable Class ProgressRing Inherits Control Implements IProgressRing// This API is not available in Javascript.
<ProgressRing .../>
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited properties

Inherited events

Inherited methods

Examples

This example shows how to set the IsActive property of a ProgressRing in code. A ToggleSwitch is used to turn the@Windows.UI.Xaml.Controls.ProgressRing?text=ProgressRing control on or off.

            <StackPanel Orientation="Horizontal">
                <ToggleSwitch Header="Toggle Switch Example" OffContent="Do work" 
                              OnContent="Working" Toggled="ToggleSwitch_Toggled"/>  
                <ProgressRing x:Name="progress1"/>
            </StackPanel>
        private void ToggleSwitch_Toggled(object sender, RoutedEventArgs e)
        {
            ToggleSwitch toggleSwitch = sender as ToggleSwitch;
            if (toggleSwitch != null)
            {
                if (toggleSwitch.IsOn == true)
                {
                    progress1.IsActive = true;
                    progress1.Visibility = Visibility.Visible;
                }
                else
                {
                    progress1.IsActive = false;
                    progress1.Visibility = Visibility.Collapsed;
                }
            }
        }

Remarks

ProgressRing is a control that indicates indeterminate progress by displaying an animated ring.

Progress ring control

Use a ProgressRing to visually indicate that an operation is in progress. Set the IsActive property to turn the ProgressRing on or off. If IsActive is false, the ProgressRing is not shown, but space is reserved for it in the UI layout. To not reserve space for the ProgressRing, set its Visibility property to Collapsed.

Notes for Windows 8.x

Windows 8.x In an app compiled for Windows 8, when the ProgressRing is active, the progress animation continues even if its not visible on the screen, such as when it's Visibility is Collapsed. This can keep the UI thread awake, use resources, and impair app performance. When the ProgressRing is not visible, you should disable the animation by setting IsActive to false.

Constructors

ProgressRing() ProgressRing() ProgressRing() ProgressRing()

Initializes a new instance of the ProgressRing class.

public : ProgressRing()public ProgressRing()Public Sub New()// This API is not available in Javascript.

Properties

IsActive IsActive IsActive IsActive

Gets or sets a value that indicates whether the ProgressRing is showing progress.

public : PlatForm::Boolean IsActive { get; set; }public bool IsActive { get; set; }Public ReadWrite Property IsActive As bool// This API is not available in Javascript.
<ProgressRing IsActive="bool" />
Value
PlatForm::Boolean bool bool bool

True if the ProgressRing is showing progress; otherwise, false. The default is false.

Remarks

Set the IsActive property to turn the ProgressRing on or off. If IsActive is false, the ProgressRing is not shown, but space is reserved for it in the UI layout. To not reserve space for the ProgressRing, set it's Visibility property to Collapsed.

Notes for Windows 8.x

Windows 8.x In an app compiled for Windows 8, when the ProgressRing is active, the progress animation continues even if its not visible on the screen, such as when it's Visibility is Collapsed. This can keep the UI thread awake, use resources, and impair app performance. When the ProgressRing is not visible, you should disable the animation by setting IsActive to false.

IsActiveProperty IsActiveProperty IsActiveProperty IsActiveProperty

Identifies the IsActive dependency property.

public : static DependencyProperty IsActiveProperty { get; }public static DependencyProperty IsActiveProperty { get; }Public Static ReadOnly Property IsActiveProperty As DependencyProperty// This API is not available in Javascript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the IsActive dependency property.

TemplateSettings TemplateSettings TemplateSettings TemplateSettings

Gets an object that provides calculated values that can be referenced as TemplateBinding sources when defining templates for a ProgressRing control.

public : ProgressRingTemplateSettings TemplateSettings { get; }public ProgressRingTemplateSettings TemplateSettings { get; }Public ReadOnly Property TemplateSettings As ProgressRingTemplateSettings// This API is not available in Javascript.

See Also