IncrementalStrokeHitTester Class

 
System_CAPS_noteNote

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

Dynamically hit tests a stroke with an eraser path.

Namespace:   System.Windows.Ink
Assembly:  PresentationCore (in PresentationCore.dll)

System.Object
  System.Windows.Ink.IncrementalHitTester
    System.Windows.Ink.IncrementalStrokeHitTester

public class IncrementalStrokeHitTester : IncrementalHitTester

NameDescription
System_CAPS_pubpropertyIsValid

Gets whether the IncrementalHitTester is hit testing.(Inherited from IncrementalHitTester.)

NameDescription
System_CAPS_pubmethodAddPoint(Point)

Adds a Point to the IncrementalHitTester.(Inherited from IncrementalHitTester.)

System_CAPS_pubmethodAddPoints(IEnumerable<Point>)

Adds points to the IncrementalHitTester.(Inherited from IncrementalHitTester.)

System_CAPS_pubmethodAddPoints(StylusPointCollection)

Adds the specified StylusPoint objects to the IncrementalHitTester.(Inherited from IncrementalHitTester.)

System_CAPS_protmethodAddPointsCore(IEnumerable<Point>)
System_CAPS_pubmethodEndHitTesting()

Releases resources used by the IncrementalHitTester. (Inherited from IncrementalHitTester.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnStrokeHit(StrokeHitEventArgs)

This API supports the product infrastructure and is not intended to be used directly from your code. Raises the StrokeHit event.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubeventStrokeHit

Occurs when the IncrementalStrokeHitTester intersects an ink Stroke.

The IncrementalStrokeHitTester hit tests strokes by determining when a eraser path intersects that stroke. Use the AddPoints method in the stylus events to add the points to the IncrementalStrokeHitTester. When the points added to the IncrementalStrokeHitTester intersect a Stroke, the IncrementalStrokeHitTester raises the StrokeHit event.

The following example demonstrates how to dynamically erase a portion of a Stroke. To create a control that enables a user to erase ink, see How to: Erase Ink on a Custom Control.

// When the stylus intersects a stroke, erase that part of
// the stroke.  When the stylus dissects a stoke, the 
// Stroke.Erase method returns a StrokeCollection that contains
// the two new strokes.
void eraseTester_StrokeHit(object sender,
    StrokeHitEventArgs args)
{
    StrokeCollection eraseResult =
        args.GetPointEraseResults();
    StrokeCollection strokesToReplace = new StrokeCollection();
    strokesToReplace.Add(args.HitStroke);

    // Replace the old stroke with the new one.
    if (eraseResult.Count > 0)
    {
        presenter.Strokes.Replace(strokesToReplace, eraseResult);
    }
    else
    {
        presenter.Strokes.Remove(strokesToReplace);
    }


}

.NET Framework
Available since 3.0

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

Return to top
Show: