VisualTreeHelper VisualTreeHelper VisualTreeHelper VisualTreeHelper Class

定義

ビジュアル ツリーのノード関連の共通タスクを実行するためのユーティリティ メソッドを提供します。Provides utility methods that perform common tasks involving nodes in a visual tree.

public ref class VisualTreeHelper abstract sealed
public static class VisualTreeHelper
type VisualTreeHelper = class
Public Class VisualTreeHelper
継承
VisualTreeHelperVisualTreeHelperVisualTreeHelperVisualTreeHelper

次の例に示すのは、ビジュアル オブジェクトのすべての子孫を列挙する方法です。これは、ビジュアル オブジェクト階層のすべての描画情報をシリアル化する必要がある場合に使用できる手法です。The following example shows how to enumerate all the descendants of a visual object, which is a technique you might want to use if you were interested in serializing all the rendering information of a visual object hierarchy.

// Enumerate all the descendants of the visual object.
static public void EnumVisual(Visual myVisual)
{
    for (int i = 0; i < VisualTreeHelper.GetChildrenCount(myVisual); i++)
    {
        // Retrieve child visual at specified index value.
        Visual childVisual = (Visual)VisualTreeHelper.GetChild(myVisual, i);

        // Do processing of the child visual object.

        // Enumerate children of the child visual object.
        EnumVisual(childVisual);
    }
}
' Enumerate all the descendants of the visual object.
Public Shared Sub EnumVisual(ByVal myVisual As Visual)
	For i As Integer = 0 To VisualTreeHelper.GetChildrenCount(myVisual) - 1
		' Retrieve child visual at specified index value.
		Dim childVisual As Visual = CType(VisualTreeHelper.GetChild(myVisual, i), Visual)

		' Do processing of the child visual object.

		' Enumerate children of the child visual object.
		EnumVisual(childVisual)
	Next i
End Sub

注釈

ビジュアル ツリー内のノードには、いずれかを指定できるVisualまたはVisual3Dオブジェクト。Nodes in the visual tree can be either Visual or Visual3D objects. ビジュアル オブジェクトの種類に固有のメソッドがいずれかとして型指定されたVisualまたはVisual3Dします。Methods that are specific to a type of visual object are typed as either Visual or Visual3D. ただし、いくつかのメソッドで、VisualTreeHelperクラスを受け入れることができる、DependencyObjectビジュアル オブジェクトのいずれかの型を表す値です。However, some methods in the VisualTreeHelper class can accept a DependencyObject value that represents either type of visual object.

WPFWPF オブジェクトのいくつかの別のツリー構造にプログラムでアクセスをサポートしています。supports programmatic access to several different tree structures of objects. 主に、このビジュアル ツリーと論理ツリーとして公開されます。Primarily, this is exposed as a visual tree and a logical tree. 場合によっては、論理ツリーは内の要素の有用な表現をWPFWPF以外のレベルで、アプリケーションが概念的には、論理ツリーは実装されている、Visualクラス。In some cases, the logical tree is a more useful representation of the elements in a WPFWPF application, but conceptually the logical tree is implemented at a level beyond the Visual class. ビジュアル ツリーとは異なり、論理ツリーは、非ビジュアルのデータ オブジェクトなどListItemします。Unlike the visual tree, the logical tree can represent nonvisual data objects, such as ListItem. 論理ツリーについて詳しくは、「WPF のツリー」をご覧ください。For more information on the logical tree, see Trees in WPF. 論理ツリーは、同様のユーティリティ メソッド クラスでサポートされてもLogicalTreeHelperします。The logical tree also is supported by a similar utility method class, LogicalTreeHelper.

メソッド

GetBitmapEffect(Visual) GetBitmapEffect(Visual) GetBitmapEffect(Visual) GetBitmapEffect(Visual)

指定した BitmapEffectVisual 値を返します。Returns the BitmapEffect value for the specified Visual.

GetBitmapEffectInput(Visual) GetBitmapEffectInput(Visual) GetBitmapEffectInput(Visual) GetBitmapEffectInput(Visual)

指定した BitmapEffectInputVisual 値を返します。Returns the BitmapEffectInput value for the specified Visual.

GetCacheMode(Visual) GetCacheMode(Visual) GetCacheMode(Visual) GetCacheMode(Visual)

指定した Visual のキャッシュされた表現を取得します。Retrieves the cached representation of the specified Visual.

GetChild(DependencyObject, Int32) GetChild(DependencyObject, Int32) GetChild(DependencyObject, Int32) GetChild(DependencyObject, Int32)

指定した親内の指定したコレクション インデックス位置から子ビジュアル オブジェクトを返します。Returns the child visual object from the specified collection index within a specified parent.

GetChildrenCount(DependencyObject) GetChildrenCount(DependencyObject) GetChildrenCount(DependencyObject) GetChildrenCount(DependencyObject)

指定したビジュアル オブジェクトに含まれる子の数を返します。Returns the number of children that the specified visual object contains.

GetClip(Visual) GetClip(Visual) GetClip(Visual) GetClip(Visual)

指定した Visual のクリップ領域を Geometry 値として返します。Return the clip region of the specified Visual as a Geometry value.

GetContentBounds(Visual3D) GetContentBounds(Visual3D) GetContentBounds(Visual3D) GetContentBounds(Visual3D)

指定した Visual3D のキャッシュされた境界ボックスの四角形を返します。Returns the cached bounding box rectangle for the specified Visual3D.

GetContentBounds(Visual) GetContentBounds(Visual) GetContentBounds(Visual) GetContentBounds(Visual)

指定した Visual のキャッシュされた境界ボックスの四角形を返します。Returns the cached bounding box rectangle for the specified Visual.

GetDescendantBounds(Visual3D) GetDescendantBounds(Visual3D) GetDescendantBounds(Visual3D) GetDescendantBounds(Visual3D)

指定した Visual3D のすべての子孫に対する、すべてのコンテンツ境界ボックスの結合を返します。これには、Visual3D のコンテンツ境界ボックスも含まれます。Returns the union of all the content bounding boxes for all the descendants of the specified Visual3D, which includes the content bounding box of the Visual3D.

GetDescendantBounds(Visual) GetDescendantBounds(Visual) GetDescendantBounds(Visual) GetDescendantBounds(Visual)

Visual のすべての子孫に対する、すべてのコンテンツ境界ボックスの結合を返します。これには、Visual のコンテンツ境界ボックスも含まれます。Returns the union of all the content bounding boxes for all the descendants of the Visual, which includes the content bounding box of the Visual.

GetDpi(Visual) GetDpi(Visual) GetDpi(Visual) GetDpi(Visual)

このビジュアルが測定および表示される DPI 情報を取得します。Gets the DPI information at which this Visual is measured and rendered.

GetDrawing(Visual) GetDrawing(Visual) GetDrawing(Visual) GetDrawing(Visual)

指定した Visual の描画コンテンツを返します。Returns the drawing content of the specified Visual.

GetEdgeMode(Visual) GetEdgeMode(Visual) GetEdgeMode(Visual) GetEdgeMode(Visual)

指定した Visual のエッジ モードを EdgeMode 値として返します。Returns the edge mode of the specified Visual as an EdgeMode value.

GetEffect(Visual) GetEffect(Visual) GetEffect(Visual) GetEffect(Visual)

指定した Visual のビットマップ効果を取得します。Gets the bitmap effect for the specified Visual.

GetOffset(Visual) GetOffset(Visual) GetOffset(Visual) GetOffset(Visual)

Visual のオフセットを返します。Returns the offset of the Visual.

GetOpacity(Visual) GetOpacity(Visual) GetOpacity(Visual) GetOpacity(Visual)

Visual の不透明度を返します。Returns the opacity of the Visual.

GetOpacityMask(Visual) GetOpacityMask(Visual) GetOpacityMask(Visual) GetOpacityMask(Visual)

Brush の不透明マスクを表す Visual 値を返します。Returns a Brush value that represents the opacity mask of the Visual.

GetParent(DependencyObject) GetParent(DependencyObject) GetParent(DependencyObject) GetParent(DependencyObject)

ビジュアル オブジェクトの親を表す DependencyObject 値を返します。Returns a DependencyObject value that represents the parent of the visual object.

GetTransform(Visual) GetTransform(Visual) GetTransform(Visual) GetTransform(Visual)

TransformVisual 値を返します。Returns a Transform value for the Visual.

GetXSnappingGuidelines(Visual) GetXSnappingGuidelines(Visual) GetXSnappingGuidelines(Visual) GetXSnappingGuidelines(Visual)

x 座標 (垂直) ガイドライン コレクションを返します。Returns an X-coordinate (vertical) guideline collection.

GetYSnappingGuidelines(Visual) GetYSnappingGuidelines(Visual) GetYSnappingGuidelines(Visual) GetYSnappingGuidelines(Visual)

Y 座標 (水平) ガイドライン コレクションを返します。Returns a Y-coordinate (horizontal) guideline collection.

HitTest(Visual, Point) HitTest(Visual, Point) HitTest(Visual, Point) HitTest(Visual, Point)

Point を指定して、ヒット テストの最上位の Visual オブジェクトを返します。Returns the topmost Visual object of a hit test by specifying a Point.

HitTest(Visual3D, HitTestFilterCallback, HitTestResultCallback, HitTestParameters3D) HitTest(Visual3D, HitTestFilterCallback, HitTestResultCallback, HitTestParameters3D) HitTest(Visual3D, HitTestFilterCallback, HitTestResultCallback, HitTestParameters3D) HitTest(Visual3D, HitTestFilterCallback, HitTestResultCallback, HitTestParameters3D)

呼び出し元が定義した HitTestFilterCallback メソッドと HitTestResultCallback メソッドを使って、指定した Visual3D に対してヒット テストを開始します。Initiates a hit test on the specified Visual3D, with caller-defined HitTestFilterCallback and HitTestResultCallback methods.

HitTest(Visual, HitTestFilterCallback, HitTestResultCallback, HitTestParameters) HitTest(Visual, HitTestFilterCallback, HitTestResultCallback, HitTestParameters) HitTest(Visual, HitTestFilterCallback, HitTestResultCallback, HitTestParameters) HitTest(Visual, HitTestFilterCallback, HitTestResultCallback, HitTestParameters)

呼び出し元が定義した HitTestFilterCallback メソッドと HitTestResultCallback メソッドを使って、指定した Visual に対してヒット テストを開始します。Initiates a hit test on the specified Visual, with caller-defined HitTestFilterCallback and HitTestResultCallback methods.

SetRootDpi(Visual, DpiScale) SetRootDpi(Visual, DpiScale) SetRootDpi(Visual, DpiScale) SetRootDpi(Visual, DpiScale)

ビジュアルの DPI 情報を更新します。Updates the DPI information of a Visual. 親なしのビジュアルでのみ呼び出すことができます。It can only be called on a Visual without a parent.

適用対象