AppNotificationBuilder.AddText 方法

定义

重载

AddText(String)

将文本块添加到应用通知的 XML 有效负载。

AddText(String, AppNotificationTextProperties)

将包含显示和本地化选项的文本块添加到应用通知的 XML 有效负载。

AddText(String)

将文本块添加到应用通知的 XML 有效负载。

public:
 virtual AppNotificationBuilder ^ AddText(Platform::String ^ text) = AddText;
/// [Windows.Foundation.Metadata.Overload("AddText")]
AppNotificationBuilder AddText(winrt::hstring const& text);
[Windows.Foundation.Metadata.Overload("AddText")]
public AppNotificationBuilder AddText(string text);
function addText(text)
Public Function AddText (text As String) As AppNotificationBuilder

参数

text
String

Platform::String

winrt::hstring

包含要显示在应用通知上的文本的字符串。

返回

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

属性

示例

以下示例演示如何向应用通知的 XML 有效负载添加文本块。

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

生成的 XML 有效负载:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
        </binding>
    </visual>
</toast>

注解

最多可以将三个文本元素添加到应用通知。 超过此限制将引发错误。

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

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

适用于

AddText(String, AppNotificationTextProperties)

将包含显示和本地化选项的文本块添加到应用通知的 XML 有效负载。

public:
 virtual AppNotificationBuilder ^ AddText(Platform::String ^ text, AppNotificationTextProperties ^ properties) = AddText;
/// [Windows.Foundation.Metadata.Overload("AddText2")]
AppNotificationBuilder AddText(winrt::hstring const& text, AppNotificationTextProperties const& properties);
[Windows.Foundation.Metadata.Overload("AddText2")]
public AppNotificationBuilder AddText(string text, AppNotificationTextProperties properties);
function addText(text, properties)
Public Function AddText (text As String, properties As AppNotificationTextProperties) As AppNotificationBuilder

参数

text
String

Platform::String

winrt::hstring

包含要显示在应用通知上的文本的字符串。

properties
AppNotificationTextProperties

AppNotificationTextProperties 指定文本的显示和本地化属性。

返回

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

属性

示例

以下示例演示如何向应用通知的 XML 有效负载添加文本块。

var notification = new AppNotificationBuilder()
    .AddText("Notification text.", new AppNotificationTextProperties().SetMaxLines(2))
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

生成的 XML 有效负载:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text hint-maxLines='2'>Notification text.</text>
        </binding>
    </visual>
</toast>

注解

最多可以将三个文本元素添加到应用通知。 超过此限制将引发错误。

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

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

适用于