Visual.TransformToVisual(Visual) Method

Reference

Definition

Namespace:: System.Windows.Media

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a transform that can be used to transform coordinates from the Visual to the specified visual object.

public:
 System::Windows::Media::GeneralTransform ^ TransformToVisual(System::Windows::Media::Visual ^ visual);

public System.Windows.Media.GeneralTransform TransformToVisual (System.Windows.Media.Visual visual);

member this.TransformToVisual : System.Windows.Media.Visual -> System.Windows.Media.GeneralTransform

Public Function TransformToVisual (visual As Visual) As GeneralTransform

Parameters

visual: Visual

The Visual to which the coordinates are transformed.

Returns

GeneralTransform

A value of type GeneralTransform.

Exceptions

ArgumentNullException

visual is null.

InvalidOperationException

The visual objects are not related.

Examples

The following markup example shows a TextBlock that is contained within a StackPanel object.

<StackPanel Name="myStackPanel" Margin="8">
  <TextBlock Name="myTextBlock" Margin="4" Text="Hello, world" />
</StackPanel>

The following code example shows how to use the TransformToVisual method to retrieve the offset of the StackPanel relative to its child TextBlock. The offset values are contained within the returned GeneralTransform value.

// Return the general transform for the specified visual object.
GeneralTransform generalTransform1 = myStackPanel.TransformToVisual(myTextBlock);

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

' Return the general transform for the specified visual object.
Dim generalTransform1 As GeneralTransform = myStackPanel.TransformToVisual(myTextBlock)

' Retrieve the point value relative to the child.
Dim currentPoint As Point = generalTransform1.Transform(New Point(0, 0))

The offset takes into account the Margin values for all objects. In this case, X is -4, and Y is -4. The offset values are negative values because the parent object is negatively offset relative to its child object.

Remarks

The TransformToAncestor and TransformToDescendant methods can also be used to return a transform for a visual object.

Applies to

Share via