AppNotificationBuilder.SetHeroImage メソッド

定義

名前空間:

Microsoft.Windows.AppNotifications.Builder

オーバーロード

SetHeroImage(Uri)	通知の全幅を占める、アプリ通知の上部に表示されるイメージを設定します。
SetHeroImage(Uri, String)	指定した代替テキストを使用して、通知の全幅を占める、アプリ通知の上部に表示されるイメージを設定します。

SetHeroImage(Uri)

通知の全幅を占める、アプリ通知の上部に表示されるイメージを設定します。

public:
 virtual AppNotificationBuilder ^ SetHeroImage(Uri ^ imageUri) = SetHeroImage;

/// [Windows.Foundation.Metadata.Overload("SetHeroImage")]
AppNotificationBuilder SetHeroImage(Uri const& imageUri);

[Windows.Foundation.Metadata.Overload("SetHeroImage")]
public AppNotificationBuilder SetHeroImage(System.Uri imageUri);

function setHeroImage(imageUri)

Public Function SetHeroImage (imageUri As Uri) As AppNotificationBuilder

パラメーター

imageUri

Uri Uri

ヒーロー イメージ ファイルの URI。

戻り値

AppNotificationBuilder

追加のメソッド呼び出しをチェーンできるように、AppNotificationBuilder インスタンスを返します。

属性

OverloadAttribute

例

次の例では、アプリ通知の XML ペイロードでアプリ ロゴオーバーライドイメージを設定する方法を示します。

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .SetHeroImage(new Uri("ms-appx:///Images/HeroImage.png"))
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

結果の XML ペイロード:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
            <image placement='hero' src='ms-appx:///Images/HeroImage.png'/>
        </binding>
    </visual>
</toast>

注釈

次のスクリーンショットは、ヒーロー イメージの配置を示しています。

サポートされているイメージ ファイルの種類は次のとおりです。

• .png
• .jpg
• .svg

AppNotificationBuilder API を使用してアプリ通知用の UI を作成する方法については、「アプリ通知コンテンツ参照してください。

アプリ通知の XML スキーマのリファレンス情報については、「アプリ通知コンテンツ スキーマ」を参照してください。

SetHeroImage(Uri, String)

指定した代替テキストを使用して、通知の全幅を占める、アプリ通知の上部に表示されるイメージを設定します。

public:
 virtual AppNotificationBuilder ^ SetHeroImage(Uri ^ imageUri, Platform::String ^ alternateText) = SetHeroImage;

/// [Windows.Foundation.Metadata.Overload("SetHeroImage2")]
AppNotificationBuilder SetHeroImage(Uri const& imageUri, winrt::hstring const& alternateText);

[Windows.Foundation.Metadata.Overload("SetHeroImage2")]
public AppNotificationBuilder SetHeroImage(System.Uri imageUri, string alternateText);

function setHeroImage(imageUri, alternateText)

Public Function SetHeroImage (imageUri As Uri, alternateText As String) As AppNotificationBuilder

パラメーター

imageUri

Uri Uri

ヒーロー イメージ ファイルの URI。

alternateText

String

Platform::String

winrt::hstring

ヒーロー イメージの代替テキストを含む文字列。

戻り値

AppNotificationBuilder

追加のメソッド呼び出しをチェーンできるように、AppNotificationBuilder インスタンスを返します。

属性

OverloadAttribute

例

次の例では、アプリ通知の XML ペイロードでアプリ ロゴオーバーライドイメージを設定する方法を示します。

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .SetHeroImage(new Uri("ms-appx:///Images/HeroImage.png"), "Alternate text")
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

結果の XML ペイロード:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
            <image placement='hero' src='ms-appx:///Images/HeroImage.png'/>
        </binding>
    </visual>
</toast>

注釈

次のスクリーンショットは、ヒーロー イメージの配置を示しています。

サポートされているイメージ ファイルの種類は次のとおりです。

• .png
• .jpg
• .svg

AppNotificationBuilder API を使用してアプリ通知用の UI を作成する方法については、「アプリ通知コンテンツ参照してください。

アプリ通知の XML スキーマのリファレンス情報については、「アプリ通知コンテンツ スキーマ」を参照してください。