ShellToast Class

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

Used for displaying a toast to the user.

Inheritance Hierarchy

System..::.Object
  Microsoft.Phone.Shell..::.ShellToast

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

Syntax

Public Class ShellToast
public class ShellToast
<ShellToast .../>

The ShellToast type exposes the following members.

Constructors

  Name Description
ShellToast Initializes a new instance of the ShellToast class.

Top

Properties

  Name Description
Content Get or sets the contents of the toast message.
NavigationUri Gets or sets the URI to navigate to if the user taps the toast message.
Sound Gets or sets the sound URI of the toast message.
Title Gets or sets the title of the toast message.

Top

Methods

  Name Description
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.)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetType Gets the Type of the current instance. (Inherited from Object.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Show Displays the toast message.
ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

While the ShellToast..::.Show method can be called from any application, a toast will not be displayed if the current foreground application is the caller of the ShellToast..::.Show method. This means that this should primarily be used by a background agent.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

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.

See Also

Reference

Microsoft.Phone.Shell Namespace