ProgressRingTemplateSettings ProgressRingTemplateSettings ProgressRingTemplateSettings Class

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

Syntax

Declaration

public sealed class ProgressRingTemplateSettingspublic sealed class ProgressRingTemplateSettingsPublic NotInheritable Class ProgressRingTemplateSettings

Inheritance Hierarchy

Remarks

Get instances of ProgressRingTemplateSettings by querying the value of TemplateSettings.

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

Properties summary

Gets the template-defined diameter of the "Ellipse" element that is animated in a templated ProgressRing.

Gets the template-defined offset position of the "Ellipse" element that is animated in a templated ProgressRing.

Gets the maximum bounding size of the progress ring as rendered.

Properties

  • EllipseDiameter
    EllipseDiameter
    EllipseDiameter
    EllipseDiameter

    Gets the template-defined diameter of the "Ellipse" element that is animated in a templated ProgressRing.

    public double EllipseDiameter { get; }public double EllipseDiameter { get; }Public ReadOnly Property EllipseDiameter As doublepublic double EllipseDiameter { get; }

    Property Value

    • double
      double
      double

      The "Ellipse" width in pixels.

    Remarks

    This value might be 4, 5, or 6 pixels in size depending on progress and state.

  • EllipseOffset
    EllipseOffset
    EllipseOffset
    EllipseOffset

    Gets the template-defined offset position of the "Ellipse" element that is animated in a templated ProgressRing.

    public Thickness EllipseOffset { get; }public Thickness EllipseOffset { get; }Public ReadOnly Property EllipseOffset As Thicknesspublic Thickness EllipseOffset { get; }

    Property Value

    Remarks

    EllipseOffset alternates between 4, 7, and 9 pixels. This is controlled by the animations that exist in default ProgressRing templates.

  • MaxSideLength
    MaxSideLength
    MaxSideLength
    MaxSideLength

    Gets the maximum bounding size of the progress ring as rendered.

    public double MaxSideLength { get; }public double MaxSideLength { get; }Public ReadOnly Property MaxSideLength As doublepublic double MaxSideLength { get; }

    Property Value

    • double
      double
      double

      The maximum bounding size of the progress ring as rendered, in pixels.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.ThreadingAttribute
Windows.Foundation.Metadata.WebHostHiddenAttribute

Details

Assembly

Windows.UI.Xaml.Controls.Primitives.dll