AppNotificationBuilder.SetHeroImage Methode

Definition

Namespace:: Microsoft.Windows.AppNotifications.Builder

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Überlädt

Name	Beschreibung
SetHeroImage(Uri)	Legt das Bild fest, das oben in einer App-Benachrichtigung angezeigt wird, und nimmt die volle Breite der Benachrichtigung auf.
SetHeroImage(Uri, String)	Legt das Bild fest, das oben in einer App-Benachrichtigung angezeigt wird, wobei die volle Breite der Benachrichtigung mit dem angegebenen Alternativtext belegt wird.

SetHeroImage(Uri)

Bearbeiten

Legt das Bild fest, das oben in einer App-Benachrichtigung angezeigt wird, und nimmt die volle Breite der Benachrichtigung auf.

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

Parameter

imageUri: Uri Uri

Der URI der Hero-Bilddatei.

Gibt zurück

AppNotificationBuilder

Gibt die AppNotificationBuilder- Instanz zurück, sodass zusätzliche Methodenaufrufe verkettet werden können.

Attribute: OverloadAttribute

Beispiele

Das folgende Beispiel veranschaulicht das Festlegen eines Bilds zum Außerkraftsetzen eines App-Logos in der XML-Nutzlast für eine App-Benachrichtigung.

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

AppNotificationManager.Default.Show(notification);

Die resultierende XML-Nutzlast:

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

Hinweise

Der folgende Screenshot veranschaulicht die Platzierung des Hero-Bilds.

Screenshot einer App-Benachrichtigung mit einem Hero-Bild.

Zu den unterstützten Bilddateitypen gehören:

.png
.jpg
.svg

Anleitungen zur Verwendung der AppNotificationBuilder--APIs zum Erstellen der Benutzeroberfläche für App-Benachrichtigungen finden Sie unter App-Benachrichtigungsinhalt.

Referenzinformationen zum XML-Schema für App-Benachrichtigungen finden Sie unter App-Benachrichtigungsinhaltsschema.

Gilt für:

SetHeroImage(Uri, String)