SystemTray Class

Article
11/23/2015

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

Inheritance Hierarchy

System..::.Object
System.Windows..::.DependencyObject
Microsoft.Phone.Shell..::.SystemTray

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

Syntax

Public Class SystemTray _
    Inherits DependencyObject

public class SystemTray : DependencyObject

<SystemTray .../>

The SystemTray type exposes the following members.

Constructors

	Name	Description
	SystemTray	Creates a new instance of the SystemTray class.

Top

Properties

	Name	Description
	BackgroundColor	Gets or sets the background color of the system tray on the current application page.
	Dispatcher	Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
	ForegroundColor	Gets or sets the foreground color of the system tray on the current application page.
	IsVisible	Gets or sets the visibility of the system tray on the current application page.
	Opacity	Gets or sets the opacity factor of the system tray on the current application page.
	ProgressIndicator	Gets or sets the progress indicator on the system tray on the current application page.

Top

Methods

	Name	Description
	CheckAccess	Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
	ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject.)
	Equals(Object)	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 the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetAnimationBaseValue	Returns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
	GetBackgroundColor	Gets the value of the BackgroundColor attached property for a specified phone application page.
	GetForegroundColor	Gets the value of the ForegroundColor attached property for a specified phone application page.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetIsVisible	Gets the value of the IsVisible attached property for a specified phone application page.
	GetOpacity	Gets the value of the Opacity attached property for a specified phone application page.
	GetProgressIndicator	Gets the value of the ProgressIndicator attached property for a specified phone application page.
	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.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
	SetBackgroundColor	Sets the value of the BackgroundColor attached property for a specified phone application page.
	SetForegroundColor	Gets the value of the ForegroundColor attached property for a specified phone application page..
	SetIsVisible	Sets the value of the IsVisible attached property for a given phone application page.
	SetOpacity	Sets the value of the Opacity attached property for a specified phone application page.
	SetProgressIndicator	Sets the value of the ProgressIndicator attached property for a specified phone application page.
	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.)

Top

Fields

	Name	Description
	BackgroundColorProperty	The dependency property for BackgroundColor.
	ForegroundColorProperty	The dependency property for ForegroundColor.
	IsVisibleProperty	The dependency property for IsVisible.
	OpacityProperty	The dependency property for Opacity.
	ProgressIndicatorProperty	The dependency property for ProgressIndicator.

Top

Remarks

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

Examples

The following code example shows how to use the SystemTray class in conjunction with the ProgressIndicator class.

using Microsoft.Phone.Shell;

namespace SystemTrayTest
{
    public partial class MainPage : PhoneApplicationPage
    {
        ProgressIndicator prog;

        public MainPage()
        {
            InitializeComponent();

            SystemTray.SetIsVisible(this, true);
            SystemTray.SetOpacity(this, 0.5);
            SystemTray.SetBackgroundColor(this, Colors.Purple);
            SystemTray.SetForegroundColor(this, Colors.Yellow);

            prog = new ProgressIndicator();
            prog.IsVisible = true;
            prog.IsIndeterminate = true;
            prog.Text = "Click me...";

            SystemTray.SetProgressIndicator(this, prog);
        }
    }
}

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.5)
        SystemTray.SetBackgroundColor(Me, Colors.Blue)
        SystemTray.SetForegroundColor(Me, Colors.Yellow)

        prog = new ProgressIndicator()
        prog.IsVisible = true
        prog.IsIndeterminate = true
        prog.Text = "Click me..."

        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 your 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" Text="Click me..." />
</shell:SystemTray.ProgressIndicator>

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

Thread Safety

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

Share via