AppNotificationBuilder.SetHeroImage Método

Definição

Namespace:

Microsoft.Windows.AppNotifications.Builder

Sobrecargas

SetHeroImage(Uri)	Define a imagem exibida na parte superior de uma notificação de aplicativo, ocupando toda a largura da notificação.
SetHeroImage(Uri, String)	Define a imagem exibida na parte superior de uma notificação de aplicativo, ocupando toda a largura da notificação, com o texto alternativo especificado.

SetHeroImage(Uri)

Define a imagem exibida na parte superior de uma notificação de aplicativo, ocupando toda a largura da notificação.

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

Parâmetros

imageUri

Uri Uri

O URI do arquivo de imagem hero.

Retornos

AppNotificationBuilder

Retorna a instância AppNotificationBuilder para que chamadas de método adicionais possam ser encadeadas.

Atributos

OverloadAttribute

Exemplos

O exemplo a seguir demonstra a configuração de uma imagem de substituição do logotipo do aplicativo na carga XML para uma notificação de aplicativo.

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

AppNotificationManager.Default.Show(notification);

O conteúdo XML resultante:

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

Comentários

A captura de tela a seguir ilustra o posicionamento da imagem hero.

Os tipos de arquivo de imagem com suporte incluem:

• .png
• .jpg
• .Svg

Para obter diretrizes sobre como usar as APIs AppNotificationBuilder para criar a interface do usuário para notificações de aplicativo, consulte Conteúdo da notificação de aplicativo.

Para obter informações de referência sobre o esquema XML para notificações de aplicativo, consulte Esquema de conteúdo de notificação de aplicativo.

SetHeroImage(Uri, String)

Define a imagem exibida na parte superior de uma notificação de aplicativo, ocupando toda a largura da notificação, com o texto alternativo especificado.

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

Parâmetros

imageUri

Uri Uri

O URI do arquivo de imagem hero.

alternateText

String

Platform::String

winrt::hstring

Uma cadeia de caracteres que contém o texto alternativo para a imagem hero.

Retornos

AppNotificationBuilder

Retorna a instância AppNotificationBuilder para que chamadas de método adicionais possam ser encadeadas.

Atributos

OverloadAttribute

Exemplos

O exemplo a seguir demonstra a configuração de uma imagem de substituição do logotipo do aplicativo na carga XML para uma notificação de aplicativo.

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

AppNotificationManager.Default.Show(notification);

O conteúdo XML resultante:

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

Comentários

A captura de tela a seguir ilustra o posicionamento da imagem hero.

Os tipos de arquivo de imagem com suporte incluem:

• .png
• .jpg
• .Svg

Para obter diretrizes sobre como usar as APIs AppNotificationBuilder para criar a interface do usuário para notificações de aplicativo, consulte Conteúdo da notificação de aplicativo.

Para obter informações de referência sobre o esquema XML para notificações de aplicativo, consulte Esquema de conteúdo de notificação de aplicativo.