StatusBar StatusBar StatusBar StatusBar Class

Definition

Provides methods and properties for interacting with the status bar assocaited with an app view (window). The status bar is a user experience that the system presents on the top edge (typically) of the screen that allows users to control behavior of the device and can present progres.

public : sealed class StatusBar : IStatusBarpublic sealed class StatusBar : IStatusBarPublic NotInheritable Class StatusBar Implements IStatusBar// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Phone.PhoneContract (introduced v1)

Remarks

To obtain an object of this type, call StatusBar.GetForCurrentView.

Properties

BackgroundColor BackgroundColor BackgroundColor BackgroundColor

Gets or sets the background color of the status bar. The alpha channel of the color is not used.

public : IReference<Color> BackgroundColor { get; set; }public Nullable<Color> BackgroundColor { get; set; }Public ReadWrite Property BackgroundColor As Nullable<Color>// You can use this property in JavaScript.
Value
IReference<Color> Nullable<Color> Nullable<Color> Nullable<Color>

The background color of the status bar.

BackgroundOpacity BackgroundOpacity BackgroundOpacity BackgroundOpacity

Gets or sets the opacity of the background color of the status bar.

public : double BackgroundOpacity { get; set; }public double BackgroundOpacity { get; set; }Public ReadWrite Property BackgroundOpacity As double// You can use this property in JavaScript.
Value
double double double double

The opacity of the background color of the status bar.

ForegroundColor ForegroundColor ForegroundColor ForegroundColor

Gets or sets the foreground color of the status bar. The alpha channel of the color is not used.

public : IReference<Color> ForegroundColor { get; set; }public Nullable<Color> ForegroundColor { get; set; }Public ReadWrite Property ForegroundColor As Nullable<Color>// You can use this property in JavaScript.
Value
IReference<Color> Nullable<Color> Nullable<Color> Nullable<Color>

The foreground color of the status bar.

OccludedRect OccludedRect OccludedRect OccludedRect

Gets the region of the core window currently occluded by the status bar.

public : Rect OccludedRect { get; }public Rect OccludedRect { get; }Public ReadOnly Property OccludedRect As Rect// You can use this property in JavaScript.
Value
Rect Rect Rect Rect

The region of the core window currently occluded by the status bar.

ProgressIndicator ProgressIndicator ProgressIndicator ProgressIndicator

Gets the progress indicator for the status bar.

public : StatusBarProgressIndicator ProgressIndicator { get; }public StatusBarProgressIndicator ProgressIndicator { get; }Public ReadOnly Property ProgressIndicator As StatusBarProgressIndicator// You can use this property in JavaScript.

Methods

GetForCurrentView() GetForCurrentView() GetForCurrentView() GetForCurrentView()

Gets the status bar for the current window (app view).

public : static StatusBar GetForCurrentView()public static StatusBar GetForCurrentView()Public Static Function GetForCurrentView() As StatusBar// You can use this method in JavaScript.
Returns

The status bar for the current window (app view).

HideAsync() HideAsync() HideAsync() HideAsync()

Hides the status bar.

public : IAsyncAction HideAsync()public IAsyncAction HideAsync()Public Function HideAsync() As IAsyncAction// You can use this method in JavaScript.
Returns

The asynchronous results of the operation. Use this to determine when the async call is complete.

ShowAsync() ShowAsync() ShowAsync() ShowAsync()

Shows the status bar.

public : IAsyncAction ShowAsync()public IAsyncAction ShowAsync()Public Function ShowAsync() As IAsyncAction// You can use this method in JavaScript.
Returns

The asynchronous results of the operation. Use this to determine when the async call is complete.

Events

Hiding Hiding Hiding Hiding

This event is raised when the status bar is being hidden.

public : event TypedEventHandler Hiding<StatusBar,  object>public event TypedEventHandler Hiding<StatusBar,  object>Public Event Hiding<StatusBar,  object>// You can use this event in JavaScript.

Showing Showing Showing Showing

This event is raised when the status bar is being shown.

public : event TypedEventHandler Showing<StatusBar,  object>public event TypedEventHandler Showing<StatusBar,  object>Public Event Showing<StatusBar,  object>// You can use this event in JavaScript.