StrokeCollection.GetIncrementalStrokeHitTester(StylusShape) Method

Definition

Creates an IncrementalStrokeHitTester that hit tests the StrokeCollection with an erasing path.

C#
public System.Windows.Ink.IncrementalStrokeHitTester GetIncrementalStrokeHitTester(System.Windows.Ink.StylusShape eraserShape);

Parameters

eraserShape
StylusShape

A StylusShape that specifies the tip of the stylus.

Returns

An IncrementalStrokeHitTester that hit tests the StrokeCollection.

Examples

The following example demonstrates how to get an IncrementalStrokeHitTester that can be used to erase part of a Stroke. To create a control that enables a user to erase ink, see How to: Erase Ink on a Custom Control.

C#
// 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));
}

Remarks

The GetIncrementalStrokeHitTester method returns an IncrementalStrokeHitTester that considers a Stroke to be "hit" when the eraser path intersects it. This is useful for implementing features, such as the ability to erase part of a Stroke. The InkCanvas uses an IncrementalStrokeHitTester when the EditingMode property is set to EraseByPoint.

Applies to

Produk Versi
.NET Framework 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9, 10