TouchDevice.Capture Method (IInputElement)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Captures a touch to the specified element by using the Element capture mode.

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

public bool Capture(
	IInputElement element
)

Parameters

element
Type: System.Windows.IInputElement

The element that captures the touch input.

Return Value

Type: System.Boolean

true if the element was able to capture the touch; otherwise, false.

Exception Condition
ArgumentException

element is not a UIElement, UIElement3D, or ContentElement.

A TouchDevice cannot be captured to an element if it is already captured to another element.

The following example handles the TouchDown events that occur on a Canvas. When a touch is pressed on the Canvas, the TouchDevice is captured to the Canvas.

This example is part of a larger example that is available in the TouchDevice class overview.

private void canvas_TouchDown(object sender, TouchEventArgs e)
{
    Canvas _canvas = (Canvas)sender as Canvas;
    if (_canvas != null)
    {
        _canvas.Children.Clear();
        e.TouchDevice.Capture(_canvas);

        // Record the ID of the first touch point if it hasn't been recorded.
        if (firstTouchId == -1)
            firstTouchId = e.TouchDevice.Id;
    }
}

.NET Framework
Available since 4.0
Return to top
Show: