Stroke.GetEraseResult Method (IEnumerable<Point>, StylusShape)

 
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.

Returns the segments of the current Stroke after it is dissected by the designated path using the specified StylusShape.

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

public StrokeCollection GetEraseResult(
	IEnumerable<Point> eraserPath,
	StylusShape eraserShape
)

Parameters

eraserPath
Type: System.Collections.Generic.IEnumerable<Point>

An array of type Point that specifies the path that dissects the Stroke.

eraserShape
Type: System.Windows.Ink.StylusShape

A StylusShape that specifies the shape of the eraser.

Return Value

Type: System.Windows.Ink.StrokeCollection

A StrokeCollection that contains copies of the segments of the current Stroke after it is dissected by the specified path.

The GetEraseResult method uses eraserShape to hit test the stroke along eraserPath and returns a StrokeCollection that represent dissected segments. GetEraseResult does not change the original Stroke.

The following example demonstrates how to erase the ink that intersects a specified path.

Point[] myPoints = new Point[] {
    new Point(100, 100),
    new	Point(200, 100),
    new	Point(200, 200),
    new	Point(100, 200)};

EllipseStylusShape myStylus = new EllipseStylusShape(5.0, 5.0, 0.0);

StrokeCollection eraseResults = aStroke.GetEraseResult(myPoints, myStylus);

// inkCanvas1 is the InkCanvas on which we update the strokes
inkCanvas1.Strokes.Remove(aStroke);
inkCanvas1.Strokes.Add(eraseResults);

.NET Framework
Available since 3.0
Return to top
Show: