AppNotificationButton.SetToolTip(String) メソッド

定義

名前空間:

Microsoft.Windows.AppNotifications.Builder

アプリ通知ボタンのツール ヒント テキストを設定します。

public:
 virtual AppNotificationButton ^ SetToolTip(Platform::String ^ value) = SetToolTip;

AppNotificationButton SetToolTip(winrt::hstring const& value);

public AppNotificationButton SetToolTip(string value);

function setToolTip(value)

Public Function SetToolTip (value As String) As AppNotificationButton

パラメーター

value

String

Platform::String

winrt::hstring

ツール ヒント テキストを含む文字列。

戻り値

AppNotificationButton

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

例

次の例は、このメソッドを使用して、アプリ通知ボタンのツール ヒントを設定する方法を示しています。

var button = new AppNotificationButton("Reply")
    .AddArgument("action", "reply");

if (AppNotificationButton.IsToolTipSupported())
{
    button.SetToolTip("Click to reply.");
}

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

AppNotificationManager.Default.Show(notification);

緊急シナリオがサポートされている場合の結果の XML ペイロード:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
        </binding>
    </visual>
    <actions>
        <action content='Reply' arguments='action=reply' hint-toolTip='Click to reply'/>
    </actions>
</toast>

注釈

AppNotificationButton.ToolTip プロパティを使用して、ツール ヒント テキストを設定することもできます。

ツール ヒント テキストは、Windows 10 ビルド 19041 以降でのみサポートされています。 AppNotificationButton.IsToolTipSupported 呼び出して、ツール ヒントが現在のデバイスでサポートされているかどうかを実行時に確認します。

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

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