StrokeCollection.GetIncrementalStrokeHitTester(StylusShape) Method

Reference

Definition

Namespace:: System.Windows.Ink

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 System::Windows::Ink::IncrementalStrokeHitTester ^ GetIncrementalStrokeHitTester(System::Windows::Ink::StylusShape ^ eraserShape);

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

member this.GetIncrementalStrokeHitTester : System.Windows.Ink.StylusShape -> System.Windows.Ink.IncrementalStrokeHitTester

Public Function GetIncrementalStrokeHitTester (eraserShape As StylusShape) As IncrementalStrokeHitTester

Parameters

eraserShape: StylusShape

A StylusShape that specifies the tip of the stylus.

Returns

IncrementalStrokeHitTester

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.

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

' Prepare to collect stylus packets. Get the 
' IncrementalHitTester from the InkPresenter's 
' StrokeCollection and subscribe to its StrokeHitChanged event.
Protected Overrides Sub OnStylusDown(ByVal e As StylusDownEventArgs)

    MyBase.OnStylusDown(e)

    Dim eraserTip As New EllipseStylusShape(3, 3, 0)
    eraseTester = presenter.Strokes.GetIncrementalStrokeHitTester(eraserTip)
    AddHandler eraseTester.StrokeHit, _
        AddressOf eraseTester_StrokeHit
    eraseTester.AddPoints(e.GetStylusPoints(Me))

End Sub

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

Jagamisviis: