This documentation is archived and is not being maintained.

VisualTreeHelper.GetTransform Method

Returns a Transform value for the Visual.

Namespace:  System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)

public static Transform GetTransform(
	Visual reference
)
You cannot use methods in XAML.

Parameters

reference
Type: System.Windows.Media.Visual

The Visual whose transform value is returned.

Return Value

Type: System.Windows.Media.Transform
The transform value of the Visual, or null if reference does not have a transform defined.

Alternatively, you can use the TransformToAncestor method to return a transform value for the ancestor of a Visual. This method always returns a valid transform. The following code example shows how to use TransformToAncestor method.

// Return the general transform for the specified visual object.
GeneralTransform generalTransform1 = myTextBlock.TransformToAncestor((Visual)myTextBlock.Parent);

// Retrieve the point value relative to the parent.
Point currentPoint = generalTransform1.Transform(new Point(0, 0));

The following code example shows how to use the GetTransform method to retrieve the transform for the specified visual object.

// Return the transform for the specified visual object.
Transform transform = VisualTreeHelper.GetTransform(myDrawing);

// If there is no transform defined for the object, the return value is null. 
if (transform != null)
{
    // Return the offset of the returned transform. The offset is relative to the parent of the visual object.
    Point pt = transform.Transform(new Point(0, 0));
}

Your code should test for null before using the returned value. To return the offset of the returned transform, use the Transform method. The offset value is relative to the parent of the Visual.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
Show: