ToastContentBuilder.AddInlineImage Method

Definition

Namespace:

Microsoft.Toolkit.Uwp.Notifications

Assembly:

Microsoft.Toolkit.Uwp.Notifications.dll

Package:

Microsoft.Toolkit.Uwp.Notifications v7.1.2

Add an image inline with other toast content.

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

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

Public Function AddInlineImage (uri As Uri, Optional alternateText As String = Nothing, Optional addImageQuery As Nullable(Of Boolean) = Nothing, Optional hintCrop As Nullable(Of AdaptiveImageCrop) = Nothing, Optional hintRemoveMargin 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.

hintCrop

Nullable<AdaptiveImageCrop>

A value whether a margin is removed. images have an 8px margin around them.

hintRemoveMargin

Nullable<Boolean>

This property is not used. Setting this has no impact.

Returns

ToastContentBuilder

The current instance of ToastContentBuilder