This documentation is archived and is not being maintained.

StylusShape Class

Represents the tip of a stylus.

Namespace:  System.Windows.Ink
Assembly:  PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

public abstract class StylusShape
This class is not typically used in XAML.

The StylusShape specifies the shape, width, and height of the tip of a stylus. Methods such as Erase(Point, StylusShape) and HitTest(Point, StylusShape) use a StylusShape to determine the stylus tip of the hitting stroke. The EllipseStylusShape and RectangleStylusShape classes inherit from StylusShape.

The following example demonstrates how to create a StylusShape and pass it to the GetIncrementalStrokeHitTester method to erase a portion of a Stroke. This example assumes that there is a IncrementalStrokeHitTester called eraseTester and that its StrokeHit event has been connected to the event handler defined in this example. To create a control that allows a user to erase ink, see How to: Erase Ink on a Custom Control.

// Prepare to collect stylus packets. Get the  
// IncrementalHitTester from the InkPresenter's  
// StrokeCollection and subscribe to its StrokeHitChanged event. 
protected override void OnStylusDown(StylusDownEventArgs e)
{
    base.OnStylusDown(e);

    EllipseStylusShape eraserTip = new EllipseStylusShape(3, 3, 0);
    eraseTester = 
        presenter.Strokes.GetIncrementalStrokeHitTester(eraserTip);
    eraseTester.StrokeHit += new StrokeHitEventHandler(eraseTester_StrokeHit);
    eraseTester.AddPoints(e.GetStylusPoints(this));

}

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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: