Visual.TransformToAncestor Method (Visual)
Assembly: PresentationCore (in PresentationCore.dll)
'Declaration Public Function TransformToAncestor ( _ ancestor As Visual _ ) As GeneralTransform 'Usage Dim instance As Visual Dim ancestor As Visual Dim returnValue As GeneralTransform returnValue = instance.TransformToAncestor(ancestor)
You cannot use methods in XAML.
Parameters
- ancestor
- Type: System.Windows.Media.Visual
The Visual to which the coordinates are transformed.
| Exception | Condition |
|---|---|
| ArgumentNullException | ancestor is Nothing. |
| ArgumentException | ancestor is not an ancestor of the visual. |
| InvalidOperationException | The visual objects are not related. |
Alternatively, you can use the VisualTreeHelper.GetOffset method to retrieve the offset of a visual object relative to its parent. The offset values are contained within the returned Vector value.
// Return the offset vector for the TextBlock object. Vector vector = VisualTreeHelper.GetOffset(myTextBlock); // Convert the vector to a point value. Point currentPoint = new Point(vector.X, vector.Y);
The following markup example shows a TextBlock that is nested within two StackPanel objects.
<Window xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" > <StackPanel Margin="16"> <StackPanel Margin="8"> <TextBlock Name="myTextBlock" Margin="4" Text="Hello, world" /> </StackPanel> </StackPanel> </Window>
The following code example shows how to use the TransformToAncestor method to retrieve the offset of the TextBlock relative to the containing Window. The offset values are contained in the returned GeneralTransform.
// Return the general transform for the specified visual object. GeneralTransform generalTransform1 = myTextBlock.TransformToAncestor(this); // Retrieve the point value relative to the parent. Point currentPoint = generalTransform1.Transform(new Point(0, 0));
The offset takes into account the Margin values for all objects within the containing Window. In this case, X is 28, and Y is 28.
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.