StylusPlugIn.OnStylusLeave Method (RawStylusInput, Boolean)


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

Occurs on a pen thread when the cursor leaves the bounds of an element.

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

protected virtual void OnStylusLeave(
	RawStylusInput rawStylusInput,
	bool confirmed


Type: System.Windows.Input.StylusPlugIns.RawStylusInput

A RawStylusInput that contains information about input from the pen.

Type: System.Boolean

true if the pen actually left the bounds of the element; otherwise, false.

This method occurs on a pen thread, so minimize work in this method to avoid impacting performance.

The following example resets the StylusPlugIn when the cursor leaves the bounds of the element.

// StylusPointCollection that contains the stylus points of the current
// stroke.
StylusPointCollection points;

// Keeps track of the stylus to check whether two styluses are used on the
// digitizer.
int currentStylus;
// If the element loses focus, stop collecting the points and don't
// perform gesture recognition.
protected override void OnStylusLeave(RawStylusInput rawStylusInput, bool confirmed)
    if (confirmed)
        // Clear the StylusPointCollection
        points = null;
        currentStylus = 0;

.NET Framework
Available since 3.0
Return to top