Skip to main content
.NET Framework Class Library
InkCanvasStrokeErasing Event

Occurs just before a user erases a stroke.

Namespace:   System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
Syntax
Public Event StrokeErasing As [%$TOPIC/ms597955_en-us_VS_110_1_0_0_0_0%]
public event [%$TOPIC/ms597955_en-us_VS_110_1_0_1_0_0%] StrokeErasing
public:
 event [%$TOPIC/ms597955_en-us_VS_110_1_0_2_0_0%]^ StrokeErasing {
	void add ([%$TOPIC/ms597955_en-us_VS_110_1_0_2_0_1%]^ value);
	void remove ([%$TOPIC/ms597955_en-us_VS_110_1_0_2_0_2%]^ value);
}
member StrokeErasing : IEvent<[%$TOPIC/ms597955_en-us_VS_110_1_0_3_0_0%],
    [%$TOPIC/ms597955_en-us_VS_110_1_0_3_0_1%]>
<object StrokeErasing="[%$TOPIC/ms597955_en-us_VS_110_1_0_4_0_0%]" .../>
Remarks

Handle this event when you want to check whether a stroke should be erased. Set the Cancel property to true if you want to prevent the stroke from being erased. You can use this technique when the EditingMode or EditingModeInverted property is set to EraseByStroke or EraseByPoint.

Examples

The following example prevents any strokes rendered as highlighters from being erased. The example assumes that the InkCanvas is connected to the event handler.

Private Sub inkCanvas1_StrokeErasing(ByVal sender As Object, _
                             ByVal e As InkCanvasStrokeErasingEventArgs)

    If (e.Stroke.DrawingAttributes.IsHighlighter) Then
        e.Cancel = True 

    End If 
End Sub
void inkCanvas1_StrokeErasing(object sender, InkCanvasStrokeErasingEventArgs e)
{
    if (e.Stroke.DrawingAttributes.IsHighlighter)
    {
        e.Cancel = true;
    }
}
Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.