Edit

Share via

TileBackgroundImage Class

  • Reference

Definition

Namespace:
Microsoft.Toolkit.Uwp.Notifications
Assembly:
Microsoft.Toolkit.Uwp.Notifications.dll
Package:
Microsoft.Toolkit.Uwp.Notifications v6.1.1
Package:
Microsoft.Toolkit.Uwp.Notifications v7.0.2
Package:
Microsoft.Toolkit.Uwp.Notifications v7.1.2

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

public sealed class TileBackgroundImage : Microsoft.Toolkit.Uwp.Notifications.IBaseImage
type TileBackgroundImage = class
    interface IBaseImage
Public NotInheritable Class TileBackgroundImage
Implements IBaseImage
Inheritance
Object
TileBackgroundImage
Implements
IBaseImage

Constructors

TileBackgroundImage()

Properties

AddImageQuery

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.
AlternateText

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

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.
HintOverlay

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.
Source

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.

Applies to