UIElement.TranslatePoint(Point, UIElement) Method

Definition

Translates a point relative to this element to coordinates that are relative to the specified element.

public:
 System::Windows::Point TranslatePoint(System::Windows::Point point, System::Windows::UIElement ^ relativeTo);
public System.Windows.Point TranslatePoint (System.Windows.Point point, System.Windows.UIElement relativeTo);
member this.TranslatePoint : System.Windows.Point * System.Windows.UIElement -> System.Windows.Point
Public Function TranslatePoint (point As Point, relativeTo As UIElement) As Point

Parameters

point
Point

The point value, as relative to this element.

relativeTo
UIElement

The element to translate the given point into.

Returns

A point value, now relative to the target element rather than this source element.

Remarks

Passing null for relativeTo is permitted, and indicates that coordinates should be relative to the root element in the logical tree that this element belongs to.

This method is used for translating hit test point values. Calling this method is mainly relevant if you are authoring a control and need to process input at a lower level. If you are using existing controls, you can generally assume that completed controls will report correctly translated hit test results.

Applies to