Partager via

AppNotificationBuilder.SetHeroImage Méthode

  • Référence

Définition

Espace de noms:
Microsoft.Windows.AppNotifications.Builder

Surcharges

SetHeroImage(Uri)

Définit l’image affichée en haut d’une notification d’application, prenant toute la largeur de la notification.
SetHeroImage(Uri, String)

Définit l’image affichée en haut d’une notification d’application, prenant toute la largeur de la notification, avec le texte de remplacement spécifié.

SetHeroImage(Uri)

Modifier

Définit l’image affichée en haut d’une notification d’application, prenant toute la largeur de la notification.

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

Paramètres

imageUri
Uri Uri

URI du fichier image hero.

Retours

AppNotificationBuilder

Retourne le instance AppNotificationBuilder afin que des appels de méthode supplémentaires puissent être chaînés.

Attributs
OverloadAttribute

Exemples

L’exemple suivant illustre la définition d’une image de remplacement de logo d’application dans la charge utile XML pour une notification d’application.

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

AppNotificationManager.Default.Show(notification);

Charge utile XML résultante :

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

Remarques

La capture d’écran suivante illustre l’emplacement de l’image de héros.

Capture d’écran d’une notification d’application avec une image de héros.

Les types de fichiers image pris en charge sont les suivants :

  • .png
  • .jpg
  • .Svg

Pour obtenir des conseils sur l’utilisation des API AppNotificationBuilder pour créer l’interface utilisateur pour les notifications d’application, consultez Contenu des notifications d’application.

Pour obtenir des informations de référence sur le schéma XML pour les notifications d’application, consultez Schéma de contenu de notification d’application.

S’applique à

SetHeroImage(Uri, String)

Modifier

Définit l’image affichée en haut d’une notification d’application, prenant toute la largeur de la notification, avec le texte de remplacement spécifié.

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

Paramètres

imageUri
Uri Uri

URI du fichier image hero.

alternateText
String

Platform::String

winrt::hstring

Chaîne contenant le texte de remplacement de l’image héros.

Retours

AppNotificationBuilder

Retourne le instance AppNotificationBuilder afin que des appels de méthode supplémentaires puissent être chaînés.

Attributs
OverloadAttribute

Exemples

L’exemple suivant illustre la définition d’une image de remplacement de logo d’application dans la charge utile XML pour une notification d’application.

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

AppNotificationManager.Default.Show(notification);

Charge utile XML résultante :

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

Remarques

La capture d’écran suivante illustre l’emplacement de l’image de héros.

Capture d’écran d’une notification d’application avec une image de héros.

Les types de fichiers image pris en charge sont les suivants :

  • .png
  • .jpg
  • .Svg

Pour obtenir des conseils sur l’utilisation des API AppNotificationBuilder pour créer l’interface utilisateur pour les notifications d’application, consultez Contenu des notifications d’application.

Pour obtenir des informations de référence sur le schéma XML pour les notifications d’application, consultez Schéma de contenu de notification d’application.

S’applique à