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 架构的参考信息，请参阅 应用通知内容架构。