ProgressRingTemplateSettings Class

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Provides calculated values that can be referenced as TemplatedParent sources when defining templates for a ProgressRing control. Not intended for general use.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

public ref class ProgressRingTemplateSettings sealed : DependencyObject

/// [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyNeedsDependencyPropertyField]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
class ProgressRingTemplateSettings final : DependencyObject

[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyNeedsDependencyPropertyField]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public sealed class ProgressRingTemplateSettings : DependencyObject

Public NotInheritable Class ProgressRingTemplateSettings
Inherits DependencyObject

Inheritance

DependencyObject

ProgressRingTemplateSettings

Attributes

Microsoft.UI.Xaml.CustomAttributes.MUXPropertyNeedsDependencyPropertyFieldAttribute MarshalingBehaviorAttribute ThreadingAttribute ContractVersionAttribute

Examples

Tip

For more info, design guidance, and code examples, see Progress controls.

The WinUI 3 Gallery and WinUI 2 Gallery apps include interactive examples of most WinUI 3 and WinUI 2 controls, features, and functionality.

If installed already, open them by clicking the following links: WinUI 3 Gallery or WinUI 2 Gallery.

If they are not installed, you can download the WinUI 3 Gallery and the WinUI 2 Gallery from the Microsoft Store.

You can also get the source code for both from GitHub (use the main branch for WinUI 3 and the winui2 branch for WinUI 2).

This example shows how to set the IsActive property of a ProgressRing in code. A ToggleSwitch is used to turn theProgressRing control on or off.

<StackPanel>
   <controls:ProgressRing IsActive="{x:Bind ProgressToggle.IsOn, Mode=OneWay}" />
   <ToggleSwitch x:Name="ProgressToggle" Header="Toggle work" OffContent="Do work" OnContent="Working" IsOn="True" />
</StackPanel>

Remarks

Get instances of ProgressRingTemplateSettings by querying the value of ProgressRing.TemplateSettings.

The values from ProgressRingTemplateSettings are typically used as either the "To" or "From" values of theme animations or transitions.

Properties

EllipseDiameter	Gets the template-defined diameter of the "Ellipse" element that is animated in a templated ProgressRing. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
EllipseOffset	Gets the template-defined offset position of the "Ellipse" element that is animated in a templated ProgressRing. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
MaxSideLength	Gets the maximum bounding size of the progress ring as rendered. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).