AppNotificationBuilder.SetHeroImage 方法

參考

定義

命名空間:: Microsoft.Windows.AppNotifications.Builder

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

多載

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