ProgressRing.IsActive Property

Definition

Namespace:

Windows.UI.Xaml.Controls

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

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.ProgressRing.IsActive (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

public:
 property bool IsActive { bool get(); void set(bool value); };

bool IsActive();

void IsActive(bool value);

public bool IsActive { get; set; }

var boolean = progressRing.isActive;
progressRing.isActive = boolean;

Public Property IsActive As Boolean

<ProgressRing IsActive="bool" />

Property Value

Boolean

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 its Visibility property to Collapsed.

Notes for previous versions

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 its 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.