Microsoft.Toolkit.Uwp.Notifications

Groups semantically identify that the content in the group must either be displayed as a whole, or not displayed if it cannot fit. Groups also allow creating multiple columns. Supported on Tiles since RTM. Supported on Toasts since Anniversary Update.

Gets the only valid children of groups are . Each subgroup is displayed as a separate vertical column. Note that you must include at least one subgroup in your group, otherwise an will be thrown when you try to retrieve the XML for the notification.

An inline image.

Gets or sets the desired cropping of the image. Supported on Tiles since RTM. Supported on Toast since Anniversary Update.

Gets or sets a value whether a margin is removed. images have an 8px margin around them. You can remove this margin by setting this property to true. Supported on Tiles since RTM. Supported on Toast since Anniversary Update.

Gets or sets the horizontal alignment of the image. For Toast, this is only supported when inside an .

Gets or sets the URI of the image (Required). Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.

Gets or sets a description of the image, for users of assistive technologies.

Gets or sets set to true to allow Windows to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.

Returns the image's source string.

The image's source string.

Specifies the horizontal alignment for an image.

Default value, alignment behavior determined by renderer.

Image stretches to fill available width (and potentially available height too, depending on where the image is).

Align the image to the left, displaying the image at its native resolution.

Align the image in the center horizontally, displaying the image at its native resolution.

Align the image to the right, displaying the image at its native resolution.

Specify the desired cropping of the image.

Default value, cropping behavior determined by renderer.

Image is not cropped.

Image is cropped to a circle shape.

New in Creators Update: A progress bar. Only supported on toasts on Desktop, build 15007 or newer.

Gets or sets an optional title string. Supports data binding.

Gets or sets the value of the progress bar. Supports data binding. Defaults to 0.

Gets or sets an optional string to be displayed instead of the default percentage string. If this isn't provided, something like "70%" will be displayed.

Gets or sets a status string (Required), which is displayed underneath the progress bar. This string should reflect the status of the operation, like "Downloading..." or "Installing..."

A class that represents the progress bar's value.

Gets or sets the value (0-1) representing the percent complete.

Gets or sets a value indicating whether the progress bar is indeterminate.

Initializes a new instance of the class.

Gets an indeterminate progress bar value.

Returns a progress bar value using the specified value (0-1) representing the percent complete.

The value, 0-1, inclusive. A progress bar value.

Subgroups are vertical columns that can contain text and images. Supported on Tiles since RTM. Supported on Toasts since Anniversary Update.

Gets a list of Children. and are valid children of subgroups.

Gets or sets the width of this subgroup column by specifying the weight, relative to the other subgroups.

Gets or sets the vertical alignment of this subgroup's content.

TextStacking specifies the vertical alignment of content.

Renderer automatically selects the default vertical alignment.

Vertical align to the top.

Vertical align to the center.

Vertical align to the bottom.

An adaptive text element.

Gets or sets the text to display. Data binding support added in Creators Update, only works for toast top-level text elements.

Gets or sets the target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides any other specified locale, such as that in binding or visual. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.

Gets or sets the style that controls the text's font size, weight, and opacity. Note that for Toast, the style will only take effect if the text is inside an .

Gets or sets a value whether text wrapping is enabled. For Tiles, this is false by default. For Toasts, this is true on top-level text elements, and false inside an . Note that for Toast, setting wrap will only take effect if the text is inside an (you can use HintMaxLines = 1 to prevent top-level text elements from wrapping).

Gets or sets the maximum number of lines the text element is allowed to display. For Tiles, this is infinity by default. For Toasts, top-level text elements will have varying max line amounts (and in the Anniversary Update you can change the max lines). Text on a Toast inside an will behave identically to Tiles (default to infinity).

Gets or sets the minimum number of lines the text element must display. Note that for Toast, this property will only take effect if the text is inside an .

Gets or sets the horizontal alignment of the text. Note that for Toast, this property will only take effect if the text is inside an .

Returns the value of the Text property.

The value of the Text property.

Text style controls font size, weight, and opacity.

Style is determined by the renderer.

Default value. Paragraph font size, normal weight and opacity.

Same as Caption but with subtle opacity.

H5 font size.

Same as Body but with subtle opacity.

H5 font size, bold weight. Essentially the bold version of Body.

Same as Base but with subtle opacity.

H4 font size.

Same as Subtitle but with subtle opacity.

H3 font size.

Same as Title but with subtle opacity.

Same as Title but with top/bottom padding removed.

H2 font size.

Same as Subheader but with subtle opacity.

Same as Subheader but with top/bottom padding removed.

H1 font size.

Same as Header but with subtle opacity.

Same as Header but with top/bottom padding removed.

Controls the horizontal alignment of text.

Alignment is automatically determined by

The system automatically decides the alignment based on the language and culture.

Horizontally align the text to the left.

Horizontally align the text in the center.

Horizontally align the text to the right.

Default value

A binding value for doubles.

Gets raw value used for the implicit converter case, where dev provided a raw double. We store the raw value, so that later on when generating the XML, we can provide this value rather than binding syntax.

Gets or sets the name that maps to your binding data value.

Initializes a new instance of the class. A new binding for a double value, with the required binding value name. Do NOT include surrounding {} brackets.

The name that maps to your binding data value.

Initializes a new instance of the class. Private constructor used by the implicit converter to assign the raw value.

Creates a that has a raw value assigned.

The raw value

Returns the raw value of the .

The to obtain the raw value from.

Creates an that has tbe raw double value.

The raw value

A binding value for strings.

Gets or sets the name that maps to your binding data value.

Initializes a new instance of the class. A new binding for a string value, with the required binding name. Do NOT include surrounding {} brackets.

The name that maps to your data binding value.

Initializes a new instance of the class. Private constructor used by the implicit converter to assign the raw value.

Creates a that has a raw value assigned.

The raw value

Returns the raw value of the .

The to obtain the raw value from.

Elements that can be direct children of adaptive content, including (, , and ).

Elements that can be direct children of an , including ( and ).

Contains the base properties that an image needs.

Gets or sets the URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.

Gets or sets a description of the image, for users of assistive technologies.

Gets or sets a value whether Windows should append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.

Defines the basic properties of a text element.

Gets or sets the text to display.

Notification content object to display a glyph on a Tile's badge.

Initializes a new instance of the class. Default constructor to create a glyph badge content object.

Initializes a new instance of the class. Constructor to create a glyph badge content object with a glyph.

The glyph to be displayed on the badge.

Gets or sets the glyph to be displayed on the badge.

Retrieves the notification Xml content as a string.

The notification Xml content as a string.

Retrieves the notification XML content as a string.

The notification XML content as a string.

Retrieves the notification XML content as a WinRT Xml document.

The notification XML content as a WinRT Xml document.

The types of glyphs that can be placed on a badge.

No glyph. If there is a numeric badge, or a glyph currently on the badge, it will be removed.

A glyph representing application activity.

A glyph representing an alert.

A glyph representing an alarm.

A glyph representing availability status.

A glyph representing away status

A glyph representing busy status.

A glyph representing that a new message is available.

A glyph representing that media is paused.

A glyph representing that media is playing.

A glyph representing unavailable status.

A glyph representing an error.

A glyph representing attention status.

Notification content object to display a number on a Tile's badge.

Initializes a new instance of the class. Default constructor to create a numeric badge content object.

Initializes a new instance of the class. Constructor to create a numeric badge content object with a number.

The number that will appear on the badge. If the number is 0, the badge will be removed.

Gets or sets the number that will appear on the badge. If the number is 0, the badge will be removed.

Retrieves the notification Xml content as a string.

The notification Xml content as a string.

Retrieves the notification Xml content as a string.

The notification Xml content as a string.

Retrieves the notification Xml content as a WinRT Xml document.

The notification Xml content as a WinRT Xml document.

Retrieves the notification XML content as a string.

The notification XML content as a string.

Retrieves the notification XML content as a WinRT XML document.

The notification XML content as a WinRT XML document.

Base notification content interface to retrieve notification Xml as a string.

Retrieves the notification Xml content as a string.

The notification Xml content as a string.

Retrieves the notification Xml content as a WinRT Xml document.

The notification Xml content as a WinRT Xml document.

Exception returned when invalid notification content is provided.

This attribute should be specified at most one time on an Element class. The property's value will be written as a string in the element's body.

Gets the provided binding value, if it exists. Otherwise, falls back to the absolute value.

The type of the enum of the class properties. The collection of data-bound values. The property to obtain. The absolute value, if any. The provided binding value, if it exists. Otherwise, falls back to the absolute value.

Manages the toast notifications for an app including the ability the clear all toast history and removing individual toasts.

Initializes a new instance of the class. Do not call this. Instead, call to obtain an instance.

An AUMID that uniquely identifies your application.

Removes all notifications sent by this app from action center.

Gets all notifications sent by this app that are currently still in Action Center.

A collection of toasts.

Removes an individual toast, with the specified tag label, from action center.

The tag label of the toast notification to be removed.

Removes a toast notification from the action using the notification's tag and group labels.

The tag label of the toast notification to be removed. The group label of the toast notification to be removed.

Removes a group of toast notifications, identified by the specified group label, from action center.

The group label of the toast notifications to be removed.

Helper for .NET Framework applications to display toast notifications and respond to toast events

A constant that is used as the launch arg when your EXE is launched from a toast notification.

If you're not using MSIX or sparse packages, you must call this method to register your AUMID with the Compat library and to register your COM CLSID and EXE in LocalServer32 registry. Feel free to call this regardless, and we will no-op if running under Desktop Bridge. Call this upon application startup, before calling any other APIs.

Your implementation of NotificationActivator. Must have GUID and ComVisible attributes on class. An AUMID that uniquely identifies your application.

Registers the activator type as a COM server client so that Windows can launch your activator.

Your implementation of NotificationActivator. Must have GUID and ComVisible attributes on class.

Creates a toast notifier. You must have called first (and also if you're a classic Win32 app), or this will throw an exception.

Gets the object. You must have called first (and also if you're a classic Win32 app), or this will throw an exception.

Gets a value indicating whether http images can be used within toasts. This is true if running with package identity (MSIX or sparse package).

Code from https://github.com/qmatteoq/DesktopBridgeHelpers/edit/master/DesktopBridge.Helpers/Helpers.cs

Apps must implement this activator to handle notification activation.

This method will be called when the user clicks on a foreground or background activation on a toast. Parent app must implement this method.

The arguments from the original notification. This is either the launch argument if the user clicked the body of your toast, or the arguments from a button on your toast. Text and selection values that the user entered in your toast. Your AUMID.

A single user input key/value pair.

The key of the user input.

The value of the user input.

The COM callback that is triggered when your notification is clicked.

The method called when your notification is clicked.

The app id of the app that sent the toast. The activation arguments from the toast. The user input from the toast. The number of user inputs.

Text and selection values that the user entered on your notification. The Key is the ID of the input, and the Value is what the user entered.

Gets the value of an input with the given key.

The key of the inpupt. The value of the input.

Gets all the keys of the inputs.

Gets all the values of the inputs.

Gets how many inputs there were.

Checks whether any inpupts have the given key.

The key to look for. A boolean representing whether any inputs have the given key.

Gets an enumerator of the inputs.

An enumerator of the inputs.

Tries to get the input value for the given key.

The key of the input to look for. The value of the input. True if found an input with the specified key, else false.

Builder class used to create

Flag used to create all tile size (Small , Medium, Large and Wide)

Gets internal instance of . This is equivalent to the call to .

Initializes a new instance of the class.

Add a tile layout size that the notification will be displayed on.

The size of tile that the notification will be displayed on. Specialized tile content. Use for special tile template. Default to NULL. The current instance of

Set how the tile notification should display the application branding.

How branding should appear on the tile The tile size that the parameter should be applied to. Default to all currently supported tile size. The current instance of

Set the name that will be used to override the application's name on the tile notification.

Custom name to display on the tile in place of the application's name The tile size that parameter should be applied to. Default to all currently supported tile size. The current instance of

Set the optional background image that stays behind the tile notification.

Source of the background image The tile size that the background image should be applied to. Default to all currently supported tile size. Description of the background image, for user of assistance technology Indicating whether Windows should append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language. The opacity of the black overlay on the background image. Desired cropping of the image. The current instance of

Set the optional background image that stays behind the tile notification.

An instance of as the background image for the tile. The tile size that the background image should be applied to. Default to all currently supported tile size. The current instance of

Set the Tile's Peek Image that animate from the top of the tile notification.

Source of the peek image The tile size that the peek image should be applied to. Default to all currently supported tile size. Description of the peek image, for user of assistance technology Indicating whether Windows should append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language. The opacity of the black overlay on the peek image. Desired cropping of the image. The current instance of

Set the Tile's Peek Image that animate from the top of the tile notification.

An instance of for the Tile's peek image The tile size that the peek image should be applied to. Default to all currently supported tile size. The current instance of

Set the text stacking (vertical alignment) of the entire binding element.

Text Stacking Option The tile size that the peek image should be applied to. Default to all currently supported tile size. The current instance of

Set the tile's activation arguments for chasable tile notification.

App-Defined custom arguments that will be passed in when the user click on the tile when this tile notification is being displayed. The tile size that the custom argument should be applied to. Default to all currently supported tile size. The current instance of

Add a custom text that will appear on the tile notification.

Custom text to display on the tile. The tile size that the custom text would be added to. Default to all currently supported tile size. Style that controls the text's font size, weight, and opacity. Indicating whether text wrapping is enabled. For Tiles, this is false by default. The maximum number of lines the text element is allowed to display. For Tiles, this is infinity by default The minimum number of lines the text element must display. The horizontal alignment of the text The target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides any other specified locale, such as that in binding or visual. The current instance of

Add an adaptive child to the tile notification.

An adaptive child to add Tile size that the adaptive child should be added to. Default to all currently supported tile size. The current instance of This can be used to add Group and Subgroup to the tile.

Get the instance of that has been built by the builder with specified configuration so far.

An instance of that can be used to create tile notification.

Helper method for creating a tile notification content for using Contact tile template.

Source for the contact picture Name of the contact A description of the contact image, for users of assistive technologies. Indicating whether Windows should append a query string to the image URI supplied in the Tile notification. Gets or sets the target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides any other specified locale, such as that in binding or visual. An instance of represent a payload of a tile notification.

Helper method for creating a tile notification content for using Iconic tile template.

Source of the icon image. A description of the icon image, for users of assistive technologies. Indicating whether Windows should append a query string to the image URI supplied in the Tile notification. An instance of represent a payload of a tile notification.

Helper method for creating a tile notification content for using People tile template.

Sources of pictures that will be used on the people tile. An instance of represent a payload of a tile notification.

Helper method for creating a tile notification content for using People tile template.

Sources of pictures with description and image query indicator that will be used on the people tile. An instance of represent a payload of a tile notification.

Helper method for creating a tile notification content for using People tile template.

Pictures that will be used on the people tile. An instance of represent a payload of a tile notification.

Helper method for creating a tile notification content for using Photos tile template.

Sources of pictures that will be used on the photos tile. An instance of represent a payload of a tile notification.

Helper method for creating a tile notification content for using Photos tile template.

Sources of pictures with description and addImageQuery indicator that will be used for the photos tile. An instance of represent a payload of a tile notification.

Helper method for creating a tile notification content for using Photos tile template.

Pictures that will be used for the photos tile. An instance of represent a payload of a tile notification.

Gets or sets a default base URI that is combined with relative URIs in image source attributes.

Gets or sets the form that the Tile should use to display the app's brand.

Gets or sets a sender-defined string that uniquely identifies the content of the notification. This prevents duplicates in the situation where a large Tile template is displaying the last three wide Tile notifications. Required: NO

Gets or sets an optional string to override the Tile's display name while showing this notification.

Gets or sets the target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides that in visual, but can be overriden by that in text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string. See Remarks for when this value isn't specified.

Throws exception if value is invalid

Overlay value (0-100)

Generates an enumerable collection of children and all those children's children

Enumerable collection of children and all those children's children.

Elements that can be direct children of , including (, , and ).

Phone-only. Supported on Small, Medium, and Wide.

Gets or sets the image to display.

Gets or sets a line of text that is displayed. Not displayed on Small Tile.

Supported on Small and Medium. Enables an iconic Tile template, where you can have an icon and badge display next to each other on the Tile, in true classic Windows Phone style. The number next to the icon is achieved through a separate badge notification.

Gets or sets, at minimum, to support both Desktop and Phone, Small and Medium tiles, a square aspect ratio image with a resolution of 200x200, PNG format, with transparency and no color other than white. For more info see: http://blogs.msdn.com/b/tiles_and_toasts/archive/2015/07/31/iconic-tile-template-for-windows-10.aspx

New in 1511: Supported on Medium, Wide, and Large (Desktop and Mobile). Previously for RTM: Phone-only. Supported on Medium and Wide.

Gets images that will roll around as circles.

Animates through a slideshow of photos. Supported on all sizes.

Gets the collection of slideshow images. Up to 12 images can be provided (Mobile will only display up to 9), which will be used for the slideshow. Adding more than 12 will throw an exception.

A full-bleed background image that appears beneath the Tile content.

Gets or sets the URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.

Gets or sets a description of the image, for users of assistive technologies.

Gets or sets a black overlay on the background image. This value controls the opacity of the black overlay, with 0 being no overlay and 100 being completely black. Defaults to 20.

Gets or sets the desired cropping of the image. Previously for RTM: Did not exist, value will be ignored and background image will be displayed without any cropping.

An image used on various special templates for the Tile.

Gets or sets the URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.

Gets or sets a description of the image, for users of assistive technologies.

A text element on the Tile.

Gets or sets the text value that will be shown in the text field.

Returns the Text property's value.

The Text property's value.

The binding element contains the visual content for a specific Tile size.

Gets or sets a default base URI that is combined with relative URIs in image source attributes. Defaults to null.

Gets or sets the form that the Tile should use to display the app's brand..

Gets or sets a value whether Windows is allowed to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language; for instance, a value of "www.website.com/images/hello.png" included in the notification becomes "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us"

Gets or sets an optional string to override the Tile's display name while showing this notification.

Gets or sets an app-defined data that is passed back to your app via the TileActivatedInfo property on LaunchActivatedEventArgs when the user launches your app from the Live Tile. This allows you to know which Tile notifications your user saw when they tapped your Live Tile. On devices without the Anniversary Update, this will simply be ignored.

Gets or sets the actual content to be displayed. One of , , , , or

Visual Tile content. One of , , , , or .

Supported on all sizes. This is the recommended way of specifying your Tile content. Adaptive Tile templates are the de-facto choice for Windows 10, and you can create a wide variety of custom Tiles through adaptive.

Gets , , and objects that can be added as children. The children are displayed in a vertical StackPanel fashion.

Gets or sets an optional background image that gets displayed behind all the Tile content, full bleed.

Gets or sets an optional peek image that animates in from the top of the Tile.

Gets or sets the text stacking (vertical alignment) of the entire binding element.

The form that the Tile should use to display the app's brand.

The default choice. If ShowNameOn___ is true for the Tile size being displayed, then branding will be "Name". Otherwise it will be "None".

No branding will be displayed.

The DisplayName will be shown.

Desktop-only. The Square44x44Logo will be shown. On Mobile, this will fallback to Name.

Desktop-only. Both the DisplayName and Square44x44Logo will be shown. On Mobile, this will fallback to Name.

Represent the all tile sizes that are available.

Small Square Tile

Medium Square Tile

Wide Rectangle Tile

Large Square Tile

Base Tile element, which contains a single visual element.

Gets or sets the visual element. Required.

Retrieves the notification XML content as a string, so that it can be sent with a HTTP POST in a push notification.

The notification XML content as a string.

Retrieves the notification XML content as a WinRT XmlDocument, so that it can be used with a local Tile notification's constructor on either or .

The notification XML content as a WinRT XmlDocument.

Specify the desired cropping of the image.

Cropping style automatically determined by renderer.

Default value. Image is not cropped.

Image is cropped to a circle shape.

Specify the desired cropping of the image.

Cropping style automatically determined by renderer.

Default value. Image is not cropped.

Image is cropped to a circle shape.

A peek image that animates in from the top of the Tile.

Gets or sets the URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.

Gets or sets a description of the image, for users of assistive technologies.

Gets or sets set a value whether Windows is allowed to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.

Gets or sets a black overlay on the peek image. This value controls the opacity of the black overlay, with 0 being no overlay and 100 being completely black. Defaults to 0. Previously for RTM: Did not exist, value will be ignored and peek image will be displayed with 0 overlay.

Gets or sets the desired cropping of the image. Previously for RTM: Did not exist, value will be ignored and peek image will be displayed without any cropping.

TextStacking specifies the vertical alignment of content.

Vertical align to the top.

Vertical align to the center.

Vertical align to the bottom.

Contains multiple binding child elements, each of which defines a Tile.

Gets or sets the target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". This locale is overridden by any locale specified in binding or text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.

Gets or sets a default base URI that is combined with relative URIs in image source attributes.

Gets or sets the form that the Tile should use to display the app's brand.

Gets or sets an optional string to override the Tile's display name while showing this notification.

Gets or sets the first line of text that will be displayed on the lock screen if the user has selected your Tile as their detailed status app. Ff you specify this, you must also provide a Wide Tile binding.

Gets or sets the second line of text that will be displayed on the lock screen if the user has selected your Tile as their detailed status app. If you specify this, you must also provide a Wide Tile binding.

Gets or sets the third line of text that will be displayed on the lock screen if the user has selected your Tile as their detailed status app. If you specify this, you must also provide a Wide Tile binding.

Gets or sets app-defined data that is passed back to your app via the TileActivatedInfo property on LaunchActivatedEventArgs when the user launches your app from the Live Tile. This allows you to know which Tile notifications your user saw when they tapped your Live Tile. On devices without the Anniversary Update, this will simply be ignored.

Gets or sets an optional small binding to specify content for the small Tile size.

Gets or sets an optional medium binding to specify content for the medium Tile size.

Gets or sets an optional wide binding to specify content for the wide Tile size.

Gets or sets an optional large binding to specify content for the large Tile size. Desktop-only

Attempts to find and re-use an existing text element inside the binding. Returns true if it could. Otherwise returns false, and the caller will have to specify the detailed status using the lock hint attribute.

The lock screen line number. The lock screen line text. The binding to look in for matches. True if could re-use existing text element, otherwise false.

Builder class used to create

Add a button to the current toast.

Text to display on the button. Type of activation this button will use when clicked. Defaults to Foreground. App-defined string of arguments that the app can later retrieve once it is activated when the user clicks the button. Optional image icon for the button to display (required for buttons adjacent to inputs like quick reply). The current instance of

Add a button to the current toast.

An instance of class that implement for the button that will be used on the toast. The current instance of

Add an button to the toast that will be display to the right of the input text box, achieving a quick reply scenario.

ID of an existing in order to have this button display to the right of the input, achieving a quick reply scenario. Text to display on the button. Type of activation this button will use when clicked. Defaults to Foreground. App-defined string of arguments that the app can later retrieve once it is activated when the user clicks the button. An optional image icon for the button to display (required for buttons adjacent to inputs like quick reply) The current instance of

Add an input text box that the user can type into.

Required ID property so that developers can retrieve user input once the app is activated. Placeholder text to be displayed on the text box when the user hasn't typed any text yet. Title text to display above the text box. The current instance of

Add a combo box / drop-down menu that contain options for user to select.

Required ID property used so that developers can retrieve user input once the app is activated. List of choices that will be available for user to select. The current instance of

Add a combo box / drop-down menu that contain options for user to select.

Required ID property used so that developers can retrieve user input once the app is activated. Sets which item is selected by default, and refers to the Id property of . If you do not provide this or null, the default selection will be empty (user sees nothing). List of choices that will be available for user to select. The current instance of

Add a combo box / drop-down menu that contain options for user to select.

Required ID property used so that developers can retrieve user input once the app is activated. Title text to display above the Combo Box. Sets which item is selected by default, and refers to the Id property of . If you do not provide this or null, the default selection will be empty (user sees nothing). List of choices that will be available for user to select. The current instance of

Add a combo box / drop-down menu that contain options for user to select.

Add an input option to the Toast.

An instance of a class that implement that will be used on the toast. The current instance of

Gets internal instance of . This is equivalent to the call to .

Initializes a new instance of the class.

Add custom time stamp on the toast to override the time display on the toast.

Custom Time to be displayed on the toast The current instance of

Add a header to a toast.

A developer-created identifier that uniquely identifies this header. If two notifications have the same header id, they will be displayed underneath the same header in Action Center. A title for the header. A developer-defined string of arguments that is returned to the app when the user clicks this header. The current instance of More info about toast header: https://docs.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/toast-headers

Add info that can be used by the application when the app was activated/launched by the toast.

Custom app-defined launch arguments to be passed along on toast activation Set the activation type that will be used when the user click on this toast The current instance of

Sets the amount of time the Toast should display. You typically should use the Scenario attribute instead, which impacts how long a Toast stays on screen.

Duration of the toast The current instance of

Sets the scenario, to make the Toast behave like an alarm, reminder, or more.

Scenario to be used for the toast's behavior The current instance of

Set custom audio to go along with the toast.

Source to the media that will be played when the toast is pop Indicating whether sound should repeat as long as the Toast is shown; false to play only once (default). Indicating whether sound is muted; false to allow the Toast notification sound to play (default). The current instance of

Get the instance of that has been built by the builder with specified configuration so far.

An instance of that can be used to create tile notification.

Create an instance of NotificationData that can be used to update toast that has a progress bar.

Instance of ToastContent that contain progress bars that need to be updated Index of the progress bar (0-based) that this notification data is updating in the case that toast has multiple progress bars. Default to 0. Title of the progress bar. Value of the progress bar. An optional string to be displayed instead of the default percentage string. If this isn't provided, something like "70%" will be displayed. A status string, which is displayed underneath the progress bar on the left. Default to empty. A sequence number to prevent out-of-order updates, or assign 0 to indicate "always update". An instance of NotificationData that can be used to update the toast.

Add an Attribution Text to be displayed on the toast.

Text to be displayed as Attribution Text The target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The current instance of

Override the app logo with custom image of choice that will be displayed on the toast.

The URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size. Specify how the image should be cropped. A description of the image, for users of assistive technologies. A value whether Windows is allowed to append a query string to the image URI supplied in the Tile notification. The current instance of

Add a hero image to the toast.

Add an image inline with other toast content.

The URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size. A description of the image, for users of assistive technologies. A value whether Windows is allowed to append a query string to the image URI supplied in the Tile notification. A value whether a margin is removed. images have an 8px margin around them. the horizontal alignment of the image.This is only supported when inside an . The current instance of

Add a progress bar to the toast.

Title of the progress bar. Value of the progress bar. Default is 0 Determine if the progress bar value should be indeterminate. Default to false. An optional string to be displayed instead of the default percentage string. If this isn't provided, something like "70%" will be displayed. A status string which is displayed underneath the progress bar. This string should reflect the status of the operation, like "Downloading..." or "Installing...". Default to empty. The current instance of More info at: https://docs.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/toast-progress-bar

Add text to the toast.

Custom text to display on the tile. Style that controls the text's font size, weight, and opacity. Indicating whether text wrapping is enabled. For Tiles, this is false by default. The maximum number of lines the text element is allowed to display. For Tiles, this is infinity by default The minimum number of lines the text element must display. The horizontal alignment of the text The target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides any other specified locale, such as that in binding or visual. The current instance of Throws when attempting to add/reserve more than 4 lines on a single toast. Throws when value is larger than 2. More info at: https://docs.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/adaptive-interactive-toasts#text-elements

Add a visual element to the toast.

An instance of a class that implement . The current instance of

The amount of time the Toast should display.

Default value. Toast appears for a short while and then goes into Action Center.

Toast stays on-screen for longer, and then goes into Action Center.

Specifies the scenario, controlling behaviors about the Toast.

The normal Toast behavior. The Toast appears for a short duration, and then automatically dismisses into Action Center.

Causes the Toast to stay on-screen and expanded until the user takes action. Also causes a looping alarm sound to be selected by default.

Causes the Toast to stay on-screen and expanded until the user takes action.

Causes the Toast to stay on-screen and expanded until the user takes action (on Mobile this expands to full screen). Also causes a looping incoming call sound to be selected by default.

Gets or sets the text to be displayed on the button.

Gets or sets the arguments attribute describing the app-defined data that the app can later retrieve once it is activated from user taking this action.

Gets or sets optional value to provide an image icon for this action to display inside the button alone with the text content.

Gets or sets value used for the quick reply scenario.

Default value. Your foreground app is launched.

Your corresponding background task (assuming you set everything up) is triggered, and you can execute code in the background (like sending the user's quick reply message) without interrupting the user.

Launch a different app using protocol activation.

System handles the activation.

Gets or sets the media file to play in place of the default sound. This can either be a ms-winsoundevent value, or a custom ms-appx:/// or ms-appdata:/// file, or null for the default sound.

Gets or sets a value indicating whether the sound is muted; false to allow the Toast notification sound to play.

Gets or sets a default base URI that is combined with relative URIs in image source attributes.

Specify the desired cropping of the image.

Default value. Image is not cropped.

Image is cropped to a circle shape.

Gets or sets the required attributes for developers to retrieve user inputs once the app is activated (in the foreground or background).

Gets or sets the optional title attribute and is for developers to specify a title for the input for shells to render when there is affordance.

Gets or sets the optional placeholderContent attribute and is the grey-out hint text for text input type. This attribute is ignored when the input type is not �text�.

Gets or sets the optional defaultInput attribute and it allows developer to provide a default input value.

Gets or sets the id attribute for apps to retrieve back the user selected input after the app is activated. Required

Gets or sets the text to display for this selection element.

Actions to display on a Toast notification. One of or .

Gets custom context menu items, providing additional actions when the user right clicks the Toast notification. New in Anniversary Update

Elements that can be direct children of , including (, , and ).

One of , , or .

Gets or sets an optional image icon for the button to display (required for buttons adjacent to inputs like quick reply).

Gets or sets an identifier used in telemetry to identify your category of action. This should be something like "Delete", "Reply", or "Archive". In the upcoming toast telemetry dashboard in Dev Center, you will be able to view how frequently your actions are being clicked.

An input element on a Toast notification. One of or .

Create your own custom actions, using controls like , , and .

Gets inputs like and . Only up to 5 inputs can be added; after that, an exception is thrown.

Gets buttons displayed after all the inputs (or adjacent to inputs if used as quick reply buttons). Only up to 5 buttons can be added (or fewer if you are also including context menu items). After that, an exception is thrown. You can add , , or

Gets custom context menu items, providing additional actions when the user right clicks the Toast notification. You can only have up to 5 buttons and context menu items *combined*. Thus, if you have one context menu item, you can only have four buttons, etc. New in Anniversary Update:

Automatically constructs a selection box for snooze intervals, and snooze/dismiss buttons, all automatically localized, and snoozing logic is automatically handled by the system.

Gets custom context menu items, providing additional actions when the user right clicks the Toast notification. You can only have up to 5 items. New in Anniversary Update

New in Creators Update: Additional options relating to activation.

Gets or sets the target PFN if you are using . You can optionally specify, so that regardless of whether multiple apps are registered to handle the same protocol uri, your desired app will always be launched.

Gets or sets the behavior that the toast should use when the user invokes this action. Note that this option only works on and . Desktop-only, supported in builds 16251 or higher. New in Fall Creators Update

Specify audio to be played when the Toast notification is received.

Gets or sets the media file to play in place of the default sound.

Gets or sets a value indicating whether sound should repeat as long as the Toast is shown; false to play only once (default).

Gets or sets a value indicating whether sound is muted; false to allow the Toast notification sound to play (default).

Generic Toast binding, where you provide text, images, and other visual elements for your Toast notification.

Gets the contents of the body of the Toast, which can include , , and (added in Anniversary Update). Also, elements must come before any other elements. If an element is placed after any other element, an exception will be thrown when you try to retrieve the Toast XML content. And finally, certain properties like HintStyle aren't supported on the root children text elements, and only work inside an . If you use on devices without the Anniversary Update, the group content will simply be dropped.

Gets or sets an optional override of the logo displayed on the Toast notification.

Gets or sets an optional hero image (a visually impactful image displayed on the Toast notification). On devices without the Anniversary Update, the hero image will simply be ignored.

Gets or sets an optional text element that is displayed as attribution text. On devices without the Anniversary Update, this text will appear as if it's another element at the end of your Children list.

Gets or sets the target locale of the XML payload, specified as BCP-47 language tags such as "en-US" or "fr-FR". This locale is overridden by any locale specified in binding or text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.

Gets or sets a default base URI that is combined with relative URIs in image source attributes.

Gets or sets a value whether Windows is allowed to append a query string to the image URI supplied in the Toast notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.

Specifies content you want to appear in a My People shoulder tap notification. For more info, see the My People notifications documentation. New in Fall Creators Update.

Gets or sets the image to be displayed in the shoulder tap notification. Required.

Gets or sets a default base URI that is combined with relative URIs in image source attributes.

A button that the user can click on a Toast notification.

Initializes a new instance of the class.

The text to display on the button. App-defined string of arguments that the app can later retrieve once it is activated when the user clicks the button.

Gets the text to display on the button. Required

Gets app-defined string of arguments that the app can later retrieve once it is activated when the user clicks the button. Required

Gets or sets what type of activation this button will use when clicked. Defaults to Foreground.

Gets or sets additional options relating to activation of the toast button. New in Creators Update

Gets or sets an optional image icon for the button to display (required for buttons adjacent to inputs like quick reply).

Gets or sets the ID of an existing in order to have this button display to the right of the input, achieving a quick reply scenario.

A button that, when clicked, is interpreted as a "dismiss" by the system, and the Toast is dismissed just like if the user swiped the Toast away.

Gets custom text displayed on the button that overrides the default localized "Dismiss" text.

Gets or sets an optional image icon for the button to display.

Initializes a new instance of the class.

Initializes a new instance of the class. Constructs a system-handled dismiss button that displays your text on the button.

The text you want displayed on the button.

A system-handled snooze button that automatically handles snoozing of a Toast notification.

Gets custom text displayed on the button that overrides the default localized "Snooze" text.

Gets or sets an optional image icon for the button to display.

Gets or sets the ID of an existing in order to allow the user to pick a custom snooze time. Optional. The ID's of the s inside the selection box must represent the snooze interval in minutes. For example, if the user selects an item that has an ID of "120", then the notification will be snoozed for 2 hours. When the user clicks this button, if you specified a SelectionBoxId, the system will parse the ID of the selected item and snooze by that amount of minutes. If you didn't specify a SelectionBoxId, the system will snooze by the default system snooze time.

Initializes a new instance of the class.

Initializes a new instance of the class. Initializes a system-handled snooze button that displays your text on the button and automatically handles snoozing.

The text you want displayed on the button.

Decides the type of activation that will be used when the user interacts with the Toast notification.

Default value. Your foreground app is launched.

Launch a different app using protocol activation.

Specifies the behavior that the toast should use when the user takes action on the toast.

Default behavior. The toast will be dismissed when the user takes action on the toast.

After the user clicks a button on your toast, the notification will remain present, in a "pending update" visual state. You should immediately update your toast from a background task so that the user does not see this "pending update" visual state for too long.

Base Toast element, which contains at least a visual element.

Gets or sets the visual element (Required).

Gets or sets custom audio options.

Gets or sets optional custom actions with buttons and inputs (using ) or optionally use the system-default snooze/dismiss controls (with ).

Gets or sets an optional header for the toast notification. Requires Creators Update

Gets or sets the scenario, to make the Toast behave like an alarm, reminder, or more.

Gets or sets the amount of time the Toast should display. You typically should use the Scenario attribute instead, which impacts how long a Toast stays on screen.

Gets or sets a string that is passed to the application when it is activated by the Toast. The format and contents of this string are defined by the app for its own use. When the user taps or clicks the Toast to launch its associated app, the launch string provides the context to the app that allows it to show the user a view relevant to the Toast content, rather than launching in its default way.

Gets or sets what activation type will be used when the user clicks the body of this Toast.

Gets or sets additional options relating to activation of the toast notification. Requires Creators Updated

Gets or sets an optional custom time to use for the notification's timestamp, visible within Action Center. If provided, this date/time will be used on the notification instead of the date/time that the notification was received. Requires Creators Update

Gets or sets an identifier used in telemetry to identify your category of toast notification. This should be something like "NewMessage", "AppointmentReminder", "Promo30Off", or "PleaseRate". In the upcoming toast telemetry dashboard in Dev Center, you will be able to view activation info filtered by toast identifier.

Gets or sets the person that this toast is related to. For more info, see the My People documentation. New in Fall Creators Update.

Gets a dictionary where you can assign additional properties.

Retrieves the notification XML content as a string, so that it can be sent with a HTTP POST in a push notification.

The notification XML content as a string.

Retrieves the notification XML content as a WinRT XmlDocument, so that it can be used with a local Toast notification's constructor on either or .

The notification XML content as a WinRT XmlDocument.

A Toast context menu item.

Initializes a new instance of the class. A Toast context menu item with the required properties.

The text to display on the menu item. App-defined string of arguments that the app can later retrieve once it is activated when the user clicks the menu item.

Gets the text to display on the menu item. Required

Gets app-defined string of arguments that the app can later retrieve once it is activated when the user clicks the menu item. Required

Gets or sets what type of activation this menu item will use when clicked. Defaults to Foreground.

Gets or sets additional options relating to activation of the toast context menu item. New in Creators Update

Gets or sets an identifier used in telemetry to identify your category of action. This should be something like "TurnOff" or "ManageSettings". In the upcoming toast telemetry dashboard in Dev Center, you will be able to view how frequently your actions are being clicked.

The logo that is displayed on your Toast notification.

Initializes a new instance of the class, a logo that is displayed on your Toast notification.

Gets or sets the URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.

Gets or sets a description of the image, for users of assistive technologies.

Gets or sets specify how the image should be cropped.

Specify the desired cropping of the image.

Cropping uses the default behavior of the renderer.

Image is not cropped.

Image is cropped to a circle shape.

Defines an attribution text element to be displayed on the Toast notification.

Initializes a new instance of the class. An attribution text element to be displayed on the Toast notification.

Gets or sets the text to display.

A hero image for the Toast notification.

Initializes a new instance of the class. A hero image for the Toast notification.

Gets or sets the URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.

Gets or sets a description of the image, for users of assistive technologies.

Defines a visual header for the toast notification.

Initializes a new instance of the class. Constructs a toast header with all the required properties.

Gets or sets a developer-created identifier that uniquely identifies this header. If two notifications have the same header id, they will be displayed underneath the same header in Action Center. Cannot be null.

Gets or sets a title for the header. Cannot be null.

Gets or sets a developer-defined string of arguments that is returned to the app when the user clicks this header. Cannot be null.

Gets or sets the type of activation this header will use when clicked. Defaults to Foreground. Note that only Foreground and Protocol are supported.

Gets or sets additional options relating to activation of the toast header. New in Creators Update

Specify what person this toast is related to. For more info, see the My People documentation. New in Fall Creators Update.

Gets or sets a remote identifier that corresponds with the RemoteId you set on a Contact you created with the ContactStore APIs. For more info, see the My People documentation.

Gets or sets an email address that corresponds with a contact in the local Windows ContactStore. Note that if is specified, this property will be ignored. For more info, see the My People documentation.

Gets or sets a phone number that corresponds with a contact in the local Windows ContactStore. Note that if is specified, this property will be ignored. For more info, see the My People documentation.

A selection box control, which lets users pick from a dropdown list of options.

Initializes a new instance of the class. A Toast SelectionBox input control with the required elements.

Developer-provided ID that the developer uses later to retrieve input when the Toast is interacted with.

Gets the required ID property used so that developers can retrieve user input once the app is activated.

Gets or sets title text to display above the SelectionBox.

Gets or sets which item is selected by default, and refers to the Id property of . If you do not provide this, the default selection will be empty (user sees nothing).

Gets the selection items that the user can pick from in this SelectionBox. Only 5 items can be added.

A selection box item (an item that the user can select from the drop down list).

Initializes a new instance of the class. Constructs a new Toast SelectionBoxItem with the required elements.

Developer-provided ID that the developer uses later to retrieve input when the Toast is interacted with. String that is displayed on the selection item. This is what the user sees.

Gets the required ID property used so that developers can retrieve user input once the app is activated.

Gets the required string that is displayed on the selection item.

Specifies the image to be displayed on a My People shoulder tap notification. New in Fall Creators Update.

Gets or sets the URI of the image (Required). This will be used if the sprite sheet isn't provided, or if the sprite sheet cannot be loaded. Can be from your application package, application data, or the internet. Internet images must obey the toast image size restrictions.

Gets or sets an optional sprite sheet that can be used instead of the image to display an animated sprite sheet.

Gets or sets a description of the image, for users of assistive technologies.

Gets or sets a value whether Windows should append a query string to the image URI supplied in the property. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.

Specifies a sprite sheet. New in Fall Creators Update.

Gets or sets the URI of the sprite sheet (Required). Can be from your application package, application data, or the internet. Internet sources must obey the toast image size restrictions.

Gets or sets the frame-height of the sprite sheet. Required value that must be greater than 0.

Gets or sets the frames per second at which to animate the sprite sheet. Required value that must be greater than 0 but no larger than 120.

Gets or sets the starting frame of the sprite sheet. If not specified, it will start at frame zero.

A text box control on the Toast that a user can type text into.

Initializes a new instance of the class. A new Toast TextBox input control with the required elements.

Developer-provided ID that the developer uses later to retrieve input when the Toast is interacted with.

Gets the required ID property so that developers can retrieve user input once the app is activated.

Gets or sets title text to display above the text box.

Gets or sets placeholder text to be displayed on the text box when the user hasn't typed any text yet.

Gets or sets the initial text to place in the text box. Leave this null for a blank text box.

Defines the visual aspects of a Toast notification.

Gets or sets a default base URI that is combined with relative URIs in image source attributes.

Gets or sets the generic Toast binding, which can be rendered on all devices. This binding is required and cannot be null.

Gets or sets a binding for shoulder tap notifications, which integrate with My People. See the My People documentation for more info. New in Fall Creators Update.