ProgressRing class

This topic has not yet been rated Rate this topic

ProgressRing class

[This documentation is preliminary and is subject to change.]

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.

Inheritance

Object
DependencyObject
UIElement
FrameworkElement
Control
ProgressRing

Syntax

C++


public sealed class ProgressRing : Control,
    IDependencyObject,
    IUIElement,
    IUIElementOverrides,
    IFrameworkElement,
    IFrameworkElementOverrides,
    IControl,
    IControlOverrides,
    IControlProtected,
    IProgressRing

XAML Object Element Usage


<ProgressRing .../>

Attributes

ActivatableAttribute(0x6020000)
StaticAttribute(Windows.UI.Xaml.Controls.IProgressRingStatics, 100794368)
VersionAttribute(100794368)
WebHostHiddenAttribute()

Members

The ProgressRing class has the following types of members:

Constructors
Events
Methods
Properties

Constructors

The ProgressRing class has the following constructors.

Constructor	Description
ProgressRing	Initializes a new instance of the ProgressRing class.

Events

The ProgressRing class has the following events.

Event	Description
DoubleTapped	Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element.(Inherited from UIElement)
DragEnter	Occurs when the input system reports an underlying drag event with this element as the target.(Inherited from UIElement)
DragLeave	Occurs when the input system reports an underlying drag event with this element as the origin.(Inherited from UIElement)
DragOver	Occurs when the input system reports an underlying drag event with this element as the potential drop target.(Inherited from UIElement)
Drop	Occurs when the input system reports an underlying drop event with this element as the drop target.(Inherited from UIElement)
GotFocus	Occurs when a UIElement receives focus.(Inherited from UIElement)
Holding	Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element.(Inherited from UIElement)
IsEnabledChanged	Occurs when the IsEnabled property changes.(Inherited from Control)
KeyDown	Occurs when a keyboard key is pressed while the UIElement has focus.(Inherited from UIElement)
KeyUp	Occurs when a keyboard key is released while the UIElement has focus.(Inherited from UIElement)
LayoutUpdated	Occurs when the layout of the visual tree changes.(Inherited from FrameworkElement)
Loaded	Occurs when a FrameworkElement has been constructed and added to the object tree.(Inherited from FrameworkElement)
LostFocus	Occurs when a UIElement loses focus.(Inherited from UIElement)
ManipulationCompleted	Occurs when a manipulation and inertia on the UIElement is complete.(Inherited from UIElement)
ManipulationDelta	Occurs when the input device changes position during a manipulation.(Inherited from UIElement)
ManipulationInertiaStarting	Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins.(Inherited from UIElement)
ManipulationStarted	Occurs when an input device begins a manipulation on the UIElement.(Inherited from UIElement)
ManipulationStarting	Occurs when the manipulation processor is first created.(Inherited from UIElement)
PointerCanceled	Occurs when a pointer that made contact abnormally loses contact.(Inherited from UIElement)
PointerCaptureLost	Occurs when pointer capture previously held by this element moves to another element or elsewhere.(Inherited from UIElement)
PointerEntered	Occurs when a pointer enters the hit test area of this element.(Inherited from UIElement)
PointerExited	Occurs when a pointer leaves the hit test area of this element.(Inherited from UIElement)
PointerMoved	Occurs when a pointer moves while the pointer remains within the hit test area of this element.(Inherited from UIElement)
PointerPressed	Occurs when the pointer device initiates a Press action within this element.(Inherited from UIElement)
PointerReleased	Occurs when the pointer device that previously initiated a Press action is released, while within this element.(Inherited from UIElement)
PointerWheelChanged	Occurs when the delta value of a pointer wheel changes.(Inherited from UIElement)
RightTapped	Occurs when a right-tap input stimulus happens while the pointer is over the element.(Inherited from UIElement)
SizeChanged	Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement.(Inherited from FrameworkElement)
Tapped	Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element.(Inherited from UIElement)
Unloaded	Occurs when this object is no longer connected to the main object tree.(Inherited from FrameworkElement)

Methods

The ProgressRing class has the following methods.

Method	Description
ApplyTemplate	Loads the relevant control template so that its parts can be referenced. (Inherited from Control)
Arrange	Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement)
ArrangeOverride	Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement)
CapturePointer	Sets pointer capture to a UIElement. (Inherited from UIElement)
ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject)
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
FindName	Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement)
Focus	Attempts to set the focus on the control. (Inherited from Control)
GetAnimationBaseValue	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetHashCode	Serves as a hash function for a particular type. (Inherited from Object)
GetTemplateChild	Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control)
GetType	Gets the type of the current instance. (Inherited from Object)
GetValue	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
InvalidateArrange	Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement)
InvalidateMeasure	Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement)
Measure	Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement)
MeasureOverride	Provides the behavior for the Measure pass of the layout cycle. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement)
MemberwiseClone	Creates a shallow copy of the current object. (Inherited from Object)
OnApplyTemplate	Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in an application. (Inherited from FrameworkElement)
OnApplyTemplateCore	Infrastructure for OnApplyTemplate. (Inherited from FrameworkElement)
OnCreateAutomationPeer	When implemented in a derived class, returns class-specific AutomationPeer implementations for the UI Automation infrastructure. (Inherited from UIElement)
OnDoubleTapped	Called before the DoubleTapped event occurs. (Inherited from Control)
OnDragEnter	Called before the DragEnter event occurs. (Inherited from Control)
OnDragLeave	Called before the DragLeave event occurs. (Inherited from Control)
OnDragOver	Called before the DragOver event occurs. (Inherited from Control)
OnDrop	Called before the Drop event occurs. (Inherited from Control)
OnGotFocus	Called before the GotFocus event occurs. (Inherited from Control)
OnHolding	Called before the Holding event occurs. (Inherited from Control)
OnKeyDown	Called before the KeyDown event occurs. (Inherited from Control)
OnKeyUp	Called before the KeyUp event occurs. (Inherited from Control)
OnLostFocus	Called before the LostFocus event occurs. (Inherited from Control)
OnManipulationCompleted	Called before the ManipulationCompleted event occurs. (Inherited from Control)
OnManipulationDelta	Called before the ManipulationDelta event occurs. (Inherited from Control)
OnManipulationInertiaStarting	Called before the ManipulationInertiaStarting event occurs. (Inherited from Control)
OnManipulationStarted	Called before the ManipulationStarted event occurs. (Inherited from Control)
OnManipulationStarting	Called before the ManipulationStarting event occurs. (Inherited from Control)
OnPointerCanceled	Called before the PointerCanceled event occurs. (Inherited from Control)
OnPointerCaptureLost	Called before the PointerCaptureLost event occurs. (Inherited from Control)
OnPointerEntered	Called before the PointerEntered event occurs. (Inherited from Control)
OnPointerExited	Called before the PointerExited event occurs. (Inherited from Control)
OnPointerMoved	Called before the PointerMoved event occurs. (Inherited from Control)
OnPointerPressed	Called before the PointerPressed event occurs. (Inherited from Control)
OnPointerReleased	Called before the PointerReleased event occurs. (Inherited from Control)
OnPointerWheelChanged	Called before the PointerWheelChanged event occurs. (Inherited from Control)
OnRightTapped	Called before the RightTapped event occurs. (Inherited from Control)
OnTapped	Called before the Tapped event occurs. (Inherited from Control)
ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
ReleasePointerCapture	Releases pointer captures for capture of one specific pointer by this UIElement. (Inherited from UIElement)
ReleasePointerCaptures	Releases all pointer captures held by this element. (Inherited from UIElement)
SetBinding	Attaches a binding to a FrameworkElement, using the provided binding object. (Inherited from FrameworkElement)
SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
ToString	Returns a string that represents the current object. (Inherited from Object)
TransformToVisual	Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement)
UpdateLayout	Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement)

Properties

The ProgressRing class has the following properties.

Property	Access type	Description
ActualHeight	Read-only	Gets the rendered height of a FrameworkElement.
ActualWidth	Read-only	Gets the rendered width of a FrameworkElement.
AllowDrop	Read/write	Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations.
Background	Read/write	Gets or sets a brush that provides the background of the control.
BaseUri	Read-only	Gets a URI that represents the base URI for an application at XAML load time. This property is used for relative URI resolution as part of how URIs that are specified as relative values in XAML attribute strings can generate legitimate URI values for run time use and resource loading.
BorderBrush	Read/write	Gets or sets a brush that describes the border background of a control.
BorderThickness	Read/write	Gets or sets the border thickness of a control.
CacheMode	Read/write	Gets or sets a value that indicates that rendered content should be cached when possible.
CharacterSpacing	Read/write	Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.
Clip	Read/write	Gets or sets the Geometry used to define the outline of the contents of a UIElement.
DataContext	Read/write	Gets or sets the data context for a FrameworkElement when it participates in data binding.
DefaultStyleKey	Read/write	Gets or sets the key that references the default style for the control.
DesiredSize	Read-only	Gets the size that this UIElement computed during the measure pass of the layout process.
Dispatcher	Read-only	Gets the CoreDispatcher that this object is associated with.
EllipseDiameter	Read-only	Gets the diameter of the ProgressRing control total area.
EllipseOffset	Read-only	Gets the offset of the ring graphic of the ProgressRing control versus its overall layout slot.
FlowDirection	Read/write	Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout.
FontFamily	Read/write	Gets or sets the font used to display text in the control.
FontSize	Read/write	Gets or sets the size of the text in this control.
FontStretch	Read/write	Gets or sets the degree to which a font is condensed or expanded on the screen.
FontStyle	Read/write	Gets or sets the style in which the text is rendered.
FontWeight	Read/write	Gets or sets the thickness of the specified font.
Foreground	Read/write	Gets or sets a brush that describes the foreground color.
Height	Read/write	Gets or sets the suggested height of a FrameworkElement.
HorizontalAlignment	Read/write	Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control.
HorizontalContentAlignment	Read/write	Gets or sets the horizontal alignment of the control's content.
IsActive	Read/write	Gets or sets whether the ProgressRing should finish its last animation cycle on progress complete.
IsActiveProperty	Read-only	Identifies the IsActive dependency property.
IsDoubleTapEnabled	Read/write	Gets or sets a value that determines whether the DoubleTapped event can originate from that element.
IsEnabled	Read/write	Gets or sets a value indicating whether the user can interact with the control.
IsHitTestVisible	Read/write	Gets or sets whether the contained area of this UIElement can return true values for hit testing.
IsHoldingEnabled	Read/write	Gets or sets a value that determines whether the Holding event can originate from that element.
IsRightTapEnabled	Read/write	Gets or sets a value that determines whether the RightTapped event can originate from that element.
IsTabStop	Read/write	Gets or sets a value that indicates whether a control is included in tab navigation.
IsTapEnabled	Read/write	Gets or sets a value that determines whether the Tapped event can originate from that element.
ManipulationMode	Read/write	Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures.
Margin	Read/write	Gets or sets the outer margin of a FrameworkElement.
MaxHeight	Read/write	Gets or sets the maximum height constraint of a FrameworkElement.
MaxWidth	Read/write	Gets or sets the maximum width constraint of a FrameworkElement.
MinHeight	Read/write	Gets or sets the minimum height constraint of a FrameworkElement.
MinWidth	Read/write	Gets or sets the minimum width constraint of a FrameworkElement.
Name	Read/write	Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name.
Opacity	Read/write	Gets or sets the degree of the object's opacity.
Padding	Read/write	Gets or sets the padding inside a control.
Parent	Read-only	Gets the parent object of this FrameworkElement in the object tree.
PointerCaptures	Read-only	Gets the set of all captured pointers, represented as Pointer values.
RenderSize	Read-only	Gets the final render size of a UIElement.
RenderTransform	Read/write	Gets or sets transform information that affects the rendering position of a UIElement.
RenderTransformOrigin	Read/write	Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement.
Resources	Read/write	Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax.
Style	Read/write	Gets or sets an instance Style that is applied for this object during rendering.
TabIndex	Read/write	Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key.
TabNavigation	Read/write	Gets or sets a value that modifies how tabbing and TabIndex work for this control.
Tag	Read/write	Gets or sets an arbitrary object value that can be used to store custom information about this object.
Template	Read/write	Gets or sets a control template.
Transitions	Read/write	Gets or sets the collection of Transition style elements that apply to a UIElement.
Triggers	Read-only	Gets the collection of triggers for animations that are defined for a FrameworkElement.
UseLayoutRounding	Read/write	Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels.
VerticalAlignment	Read/write	Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control.
VerticalContentAlignment	Read/write	Gets or sets the vertical alignment of the control's content.
Visibility	Read/write	Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout.
Width	Read/write	Gets or sets the width of a FrameworkElement.

Requirements

Minimum supported client	Windows Developer Preview
Minimum supported server	Windows Server Developer Preview
Namespace	Windows.UI.Xaml.Controls
Assembly	Windows.UI.Xaml.Controls.dll

ProgressRing class

EllipseDiameter property

EllipseOffset property

IsActive property

IsActiveProperty property

ProgressRing constructor

ProgressRing class

Inheritance

Syntax

Attributes

Members

Constructors

Events

Methods

Properties

Requirements

See also