Share via

AppNotificationBuilder.SetAppLogoOverride 方法

  • 参考

定义

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

重载

SetAppLogoOverride(Uri)

设置显示在应用通知左侧的图像。
SetAppLogoOverride(Uri, AppNotificationImageCrop)

使用指定的裁剪方法设置显示在应用通知左侧的图像。
SetAppLogoOverride(Uri, AppNotificationImageCrop, String)

使用指定的裁剪方法和备用文本设置显示在应用通知左侧的图像。

SetAppLogoOverride(Uri)

编辑

设置显示在应用通知左侧的图像。

public:
 virtual AppNotificationBuilder ^ SetAppLogoOverride(Uri ^ imageUri) = SetAppLogoOverride;
/// [Windows.Foundation.Metadata.Overload("SetAppLogoOverride")]
AppNotificationBuilder SetAppLogoOverride(Uri const& imageUri);
[Windows.Foundation.Metadata.Overload("SetAppLogoOverride")]
public AppNotificationBuilder SetAppLogoOverride(System.Uri imageUri);
function setAppLogoOverride(imageUri)
Public Function SetAppLogoOverride (imageUri As Uri) As AppNotificationBuilder

参数

imageUri
Uri Uri

应用徽标的 URI 将覆盖图像文件。

返回

AppNotificationBuilder

返回 AppNotificationBuilder 实例，以便可以链接其他方法调用。

属性
OverloadAttribute

示例

以下示例演示如何在应用通知的 XML 有效负载中设置应用徽标替代图像。

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

AppNotificationManager.Default.Show(notification);

生成的 XML 有效负载：

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

注解

以下屏幕截图演示了应用徽标替代图像的位置。

应用通知的屏幕截图，其中包含应用徽标替代图像。

支持的图像文件类型包括：

  • .png
  • .jpg
  • 。Svg

有关使用 AppNotificationBuilder API 创建应用通知 UI 的指导，请参阅 应用通知内容。

有关应用通知的 XML 架构的参考信息，请参阅 应用通知内容架构。

适用于

SetAppLogoOverride(Uri, AppNotificationImageCrop)

编辑

使用指定的裁剪方法设置显示在应用通知左侧的图像。

public:
 virtual AppNotificationBuilder ^ SetAppLogoOverride(Uri ^ imageUri, AppNotificationImageCrop imageCrop) = SetAppLogoOverride;
/// [Windows.Foundation.Metadata.Overload("SetAppLogoOverride2")]
AppNotificationBuilder SetAppLogoOverride(Uri const& imageUri, AppNotificationImageCrop const& imageCrop);
[Windows.Foundation.Metadata.Overload("SetAppLogoOverride2")]
public AppNotificationBuilder SetAppLogoOverride(System.Uri imageUri, AppNotificationImageCrop imageCrop);
function setAppLogoOverride(imageUri, imageCrop)
Public Function SetAppLogoOverride (imageUri As Uri, imageCrop As AppNotificationImageCrop) As AppNotificationBuilder

参数

imageUri
Uri Uri

应用徽标的 URI 将覆盖图像文件。

imageCrop
AppNotificationImageCrop

AppNotificationImageCrop 枚举的成员，指定裁剪方法。

返回

AppNotificationBuilder

返回 AppNotificationBuilder 实例，以便可以链接其他方法调用。

属性
OverloadAttribute

示例

以下示例演示如何设置应用徽标覆盖应用通知的 XML 有效负载的图像。

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .SetAppLogoOverride(new Uri("ms-appx:///Images/AppLogo.png"), AppNotificationImageCrop.Circle)
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

生成的 XML 有效负载：

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
            <image placement='appLogoOverride' src='ms-appx:///Images/AppLogo.png' hint-crop='circle'/>
        </binding>
    </visual>
</toast>

注解

以下屏幕截图演示了使用 Circle 裁剪方法的应用徽标覆盖图像的位置。

应用通知的屏幕截图，其中包含裁剪了圆圈的图像。

支持的图像文件类型包括：

  • .png
  • .jpg
  • 。Svg

有关使用 AppNotificationBuilder API 创建应用通知 UI 的指导，请参阅 应用通知内容。

有关应用通知的 XML 架构的参考信息，请参阅 应用通知内容架构。

适用于

SetAppLogoOverride(Uri, AppNotificationImageCrop, String)

编辑

使用指定的裁剪方法和备用文本设置显示在应用通知左侧的图像。

public:
 virtual AppNotificationBuilder ^ SetAppLogoOverride(Uri ^ imageUri, AppNotificationImageCrop imageCrop, Platform::String ^ alternateText) = SetAppLogoOverride;
/// [Windows.Foundation.Metadata.Overload("SetAppLogoOverride3")]
AppNotificationBuilder SetAppLogoOverride(Uri const& imageUri, AppNotificationImageCrop const& imageCrop, winrt::hstring const& alternateText);
[Windows.Foundation.Metadata.Overload("SetAppLogoOverride3")]
public AppNotificationBuilder SetAppLogoOverride(System.Uri imageUri, AppNotificationImageCrop imageCrop, string alternateText);
function setAppLogoOverride(imageUri, imageCrop, alternateText)
Public Function SetAppLogoOverride (imageUri As Uri, imageCrop As AppNotificationImageCrop, alternateText As String) As AppNotificationBuilder

参数

imageUri
Uri Uri

应用徽标的 URI 将覆盖图像文件。

imageCrop
AppNotificationImageCrop

AppNotificationImageCrop 枚举的成员，指定裁剪方法。

alternateText
String

Platform::String

winrt::hstring

包含应用徽标替代图像的备用文本的字符串。

返回

AppNotificationBuilder

返回 AppNotificationBuilder 实例，以便可以链接其他方法调用。

属性
OverloadAttribute

示例

以下示例演示如何在应用通知的 XML 有效负载中设置应用徽标替代图像。

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

AppNotificationManager.Default.Show(notification);

生成的 XML 有效负载：

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
            <image placement='appLogoOverride' src='ms-appx:///Images/AppLogo.png' alt='Alternate text' hint-crop='circle'/>
        </binding>
    </visual>
</toast>

注解

以下屏幕截图演示了使用 Circle 裁剪方法的应用徽标覆盖图像的位置。

应用通知的屏幕截图，其中包含裁剪了圆圈的图像

支持的图像文件类型包括：

  • .png
  • .jpg
  • 。Svg

有关使用 AppNotificationBuilder API 创建应用通知 UI 的指导，请参阅 应用通知内容。

有关应用通知的 XML 架构的参考信息，请参阅 应用通知内容架构。

适用于