ToastContentBuilder.AddHeroImage(Uri, String, Nullable<Boolean>) Method

Definition

Namespace:

Microsoft.Toolkit.Uwp.Notifications

Assembly:

Microsoft.Toolkit.Uwp.Notifications.dll

Package:

Microsoft.Toolkit.Uwp.Notifications v7.1.2

Add a hero image to the toast.

public Microsoft.Toolkit.Uwp.Notifications.ToastContentBuilder AddHeroImage (Uri uri, string alternateText = default, bool? addImageQuery = default);

member this.AddHeroImage : Uri * string * Nullable<bool> -> Microsoft.Toolkit.Uwp.Notifications.ToastContentBuilder

Public Function AddHeroImage (uri As Uri, Optional alternateText As String = Nothing, Optional addImageQuery As Nullable(Of Boolean) = Nothing) As ToastContentBuilder

Parameters

uri

Uri

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.

alternateText

String

A description of the image, for users of assistive technologies.

addImageQuery

Nullable<Boolean>

A value whether Windows is allowed to append a query string to the image URI supplied in the Tile notification.

Returns

ToastContentBuilder

The current instance of ToastContentBuilder