ProgressIndicator Class

July 28, 2014

Provides methods and properties for interacting with the progress indicator on the system tray on an application page.

System.Object
  System.Windows.DependencyObject
    Microsoft.Phone.Shell.ProgressIndicator

Namespace:  Microsoft.Phone.Shell
Assembly:  Microsoft.Phone (in Microsoft.Phone.dll)
XMLNS for XAML: Not mapped to an xmlns.

'Declaration
Public Class ProgressIndicator _
	Inherits DependencyObject
<ProgressIndicator .../>

The ProgressIndicator type exposes the following members.

  NameDescription
Public methodProgressIndicatorCreates a new instance of the ProgressIndicator class.
Top

  NameDescription
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyIsIndeterminateGets or sets a value that indicates whether the progress indicator on the system tray on the current application page is determinate or indeterminate.
Public propertyIsVisibleGets or sets the visibility of the progress indicator on the system tray on the current application page.
Public propertyTextGets or sets the text of the progress indicator on the system tray on the current application page.
Public propertyValueGets or sets the value of the progress indicator on the system tray on the current application page.
Top

  NameDescription
Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetAnimationBaseValueReturns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberIsIndeterminatePropertyThe dependency property for IsIndeterminate.
Public fieldStatic memberIsVisiblePropertyThe dependency property for IsVisible.
Public fieldStatic memberTextPropertyThe dependency property for Text.
Public fieldStatic memberValuePropertyThe dependency property for Value.
Top

To use the ProgressIndicator without affecting the layout of the page, set the value of the Opacity property of the SystemTray to 0 (zero).

The following screenshot shows an indeterminate progress indicator scrolling across the top of the screen in the system tray.

Example of the ProgressIndicator control

The system tray is also referred to as the status bar.

The following code example shows how to use the ProgressIndicator class.

Imports Microsoft.Phone.Shell

Partial Public Class MainPage
    Inherits PhoneApplicationPage

    Dim prog As ProgressIndicator
    
    Public Sub New()
        InitializeComponent()

        SystemTray.SetIsVisible(Me, true)
        SystemTray.SetOpacity(Me, 0)

        prog = new ProgressIndicator()
        prog.IsVisible = true
        prog.IsIndeterminate = true

        SystemTray.SetProgressIndicator(Me, prog)
    End Sub
End Class

The following code example shows how to use the ProgressIndicator on the SystemTray from XAML. This code goes inside the PHONE:PHONEAPPLICATIONPAGE element. Note that the IsIndeterminate, IsVisible, Text, and Value attributes can all be data-bound.

<shell:SystemTray.ProgressIndicator>
    <shell:ProgressIndicator IsIndeterminate="True" IsVisible="True" />
</shell:SystemTray.ProgressIndicator>

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft