AppNotificationBuilder.AddText メソッド

定義

名前空間:

Microsoft.Windows.AppNotifications.Builder

オーバーロード

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

追加のメソッド呼び出しをチェーンできるように、AppNotificationBuilder インスタンスを返します。

属性

OverloadAttribute

例

次の例では、アプリ通知の 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>

注釈

アプリ通知には、最大 3 つのテキスト要素を追加できます。 この制限を超えると、エラーがスローされます。

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

追加のメソッド呼び出しをチェーンできるように、AppNotificationBuilder インスタンスを返します。

属性

OverloadAttribute

例

次の例では、アプリ通知の 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>

注釈

アプリ通知には、最大 3 つのテキスト要素を追加できます。 この制限を超えると、エラーがスローされます。

AppNotificationBuilder API を使用してアプリ通知用の UI を作成する方法については、「アプリ通知コンテンツ参照してください。

アプリ通知の XML スキーマのリファレンス情報については、「アプリ通知コンテンツ スキーマ」を参照してください。