This documentation is archived and is not being maintained.

StylusPlugIn.OnStylusLeave Method

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
)
You cannot use methods in XAML.

Parameters

rawStylusInput
Type: System.Windows.Input.StylusPlugIns.RawStylusInput

A RawStylusInput that contains information about input from the pen.

confirmed
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;
    }
}

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.

.NET Framework

Supported in: 3.5, 3.0
Show: