ToolTipService 类

  • 参考

定义

命名空间:
Microsoft.UI.Xaml.Controls
编辑

表示提供静态方法以显示 工具提示的服务。

public ref class ToolTipService sealed
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ToolTipService final
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ToolTipService
Public NotInheritable Class ToolTipService
继承
Object Platform::Object IInspectable ToolTipService
属性
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

示例

下面的代码示例演示 工具提示的放置模式。

<StackPanel Margin="120" >
    <TextBlock Text="ToolTip Control"/>
    <TextBlock Text="Hover over an item to see its ToolTip: " Margin="0,10"/>
    <ListBox Width="100" HorizontalAlignment="Left">
        <ListBoxItem Content="Left" 
            ToolTipService.ToolTip="ToolTip to the left." 
            ToolTipService.Placement="Left" />
        <ListBoxItem Content="Right" 
            ToolTipService.ToolTip="ToolTip to the right." 
            ToolTipService.Placement="Right" />
        <ListBoxItem Content="Top" 
            ToolTipService.ToolTip="ToolTip at the top." 
            ToolTipService.Placement="Top" />
        <ListBoxItem Content="Bottom" 
            ToolTipService.ToolTip="ToolTip at the bottom." 
            ToolTipService.Placement="Bottom"/>
        <ListBoxItem Content="Mouse" 
            ToolTipService.ToolTip="ToolTip based on the cursor position." 
            ToolTipService.Placement="Mouse"/>
    </ListBox>
</StackPanel>

注解

工具提示必须分配到其所有者的其他 UI 元素。 在 Extensible Application Markup Language (XAML) 中，使用 ToolTipService.ToolTip 附加属性将 工具提示 分配给所有者。 在代码中，使用 ToolTipService.SetToolTip 方法将 工具提示 分配给所有者。

放置

默认情况下， 工具提示 显示在指针上方居中。 位置不受应用窗口约束，因此 工具提示 可能会部分或完全显示在应用窗口边界之外。

如果 工具提示 遮盖了它所引用的内容，则可以调整其位置。 使用 ToolTipService.Placement 附加属性将 工具提示 放在指针的上方、下方、左侧或右侧。

如果没有显式 PlacementTarget，则工具提示的放置目标是为其 TooltipService.ToolTip 附加属性值指定值的元素。 任何 Placement 值 (作为附加属性或显式 ToolTip 元素上的属性) 应用于该目标。

XAML 附加属性

ToolTipService 是多个 XAML 附加属性的主机服务类。

为了支持 XAML 处理器访问附加属性，以及向代码公开等效 的 get 和 set 操作，每个 XAML 附加属性都有一对 Get 和 Set 访问器方法。 在代码中获取或设置值的另一种方法是使用依赖属性系统，调用 GetValue 或 SetValue ，并将标识符字段作为依赖属性标识符传递。

附加属性 说明
放置 获取或设置一个值，该值指示工具提示相对于放置目标的位置方式。
PlacementTarget 获取或设置相对于工具提示定位的对象。
ToolTip 获取或设置元素的工具提示的对象或字符串内容。

属性

PlacementProperty

标识 ToolTipService.Placement XAML 附加属性。
PlacementTargetProperty

标识 ToolTipService.PlacementTarget XAML 附加属性。
ToolTipProperty

标识 ToolTipService.Tooltip XAML 附加属性。

附加属性

Placement

获取或设置一个值，该值指示工具提示相对于放置目标的位置方式。
PlacementTarget

获取或设置相对于工具提示定位的对象。
ToolTip

获取或设置元素的工具提示的对象或字符串内容。

方法

GetPlacement(DependencyObject)

获取指定目标元素的 ToolTipService.Placement XAML 附加属性值。
GetPlacementTarget(DependencyObject)

获取指定目标元素的 ToolTipService.PlacementTarget XAML 附加属性值。
GetToolTip(DependencyObject)

获取 对象的 ToolTipService.ToolTip XAML 附加属性的值。
SetPlacement(DependencyObject, PlacementMode)

设置指定目标元素的 ToolTipService.Placement XAML 附加属性值。
SetPlacementTarget(DependencyObject, UIElement)

设置指定目标元素的 ToolTipService.PlacementTarget XAML 附加属性值。
SetToolTip(DependencyObject, Object)

设置 ToolTipService.ToolTip XAML 附加属性的值。

适用于

另请参阅