ToolTipService クラス

リファレンス

定義

名前空間:: Windows.UI.Xaml.Controls

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

ツールヒントを表示する静的メソッドを提供するサービスを表します。

public ref class ToolTipService sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 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(Windows.Foundation.UniversalApiContract), 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

Windows の要件

デバイスファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

例

次のコード例は、ツールヒントの配置モードを示しています。

<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>

注釈

ToolTip は、その所有者である別の UI 要素に割り当てる必要があります。 Extensible Application Markup Language (XAML) で、ToolTipService.ToolTip 添付プロパティを使用して、ツールヒントを所有者に割り当てます。コードでは、 ToolTipService.SetToolTip メソッドを使用して、ツールヒントを所有者に割り当てます。

配置

既定では、ツールヒントはポインターの上の中央に表示されます。配置はアプリウィンドウによって制限されないため、ツールヒントがアプリウィンドウの境界の一部または完全に外側に表示される可能性があります。

ツールヒントで参照しているコンテンツが隠れている場合は、その配置を調整できます。 ToolTipService.Placement 添付プロパティを使用して、ポインターの上、下、左、または右にツールヒントを配置します。

PlacementTarget が明示的に存在しない場合、ツールヒントの配置ターゲットは、TooltipService.ToolTip 添付プロパティ値の値を指定する要素です。配置値 (添付プロパティとして、または明示的な ToolTip 要素の属性として) は、そのターゲットに適用されます。

以前のバージョンのメモ

Windows 8.xツールヒントは、Windows でのみ使用することを目的としています。ツールヒントの種類は、ユニバーサルプロジェクトテンプレートとの互換性のためにWindows Phone プロジェクトで使用できますが、ツールヒントはWindows Phone UI に表示されません。

ツールヒントは、アプリウィンドウの境界内にのみ表示されます。配置は、これらの境界内に留まるように調整される場合があります。

XAML 添付プロパティ

ToolTipService は、いくつかの XAML 添付プロパティのホストサービスクラスです。

アタッチされたプロパティへの XAML プロセッサアクセスをサポートし、同等の get 操作と set 操作をコードに公開するために、各 XAML 添付プロパティには Get メソッドと Set アクセサーメソッドのペアがあります。コードで値を取得または設定するもう 1 つの方法は、依存関係プロパティシステムを使用して GetValue または SetValue を呼び出し、識別子フィールドを依存関係プロパティ識別子として渡すことです。

添付プロパティ	説明
配置	が配置先に対してどのように `ToolTip` 配置されるかを示す値を取得または設定します。
PlacementTarget	が配置される `ToolTip` 相対オブジェクトを取得または設定します。
ToolTip	要素 `ToolTip`ののオブジェクトまたは文字列の内容を取得または設定します。

プロパティ

PlacementProperty	ToolTipService.Placement XAML 添付プロパティを識別します。
PlacementTargetProperty	ToolTipService.PlacementTarget XAML 添付プロパティを識別します。
ToolTipProperty	ToolTipService.ToolTip XAML 添付プロパティを識別します。

添付プロパティ

Placement	配置ターゲットに対するツールヒントの配置方法を示す値を取得または設定します。
PlacementTarget	ツールヒントの位置を基準にしたオブジェクトを取得または設定します。
ToolTip	要素の 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 添付プロパティの値を設定します。

適用対象