Share via


InkOverlay.EraserMode Property

Gets or sets a value that indicates whether ink is erased by stroke or by point.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in microsoft.ink.dll)

Syntax

'Declaration
Public Property EraserMode As InkOverlayEraserMode
'Usage
Dim instance As InkOverlay
Dim value As InkOverlayEraserMode

value = instance.EraserMode

instance.EraserMode = value
public InkOverlayEraserMode EraserMode { get; set; }
public:
property InkOverlayEraserMode EraserMode {
    InkOverlayEraserMode get ();
    void set (InkOverlayEraserMode value);
}
/** @property */
public InkOverlayEraserMode get_EraserMode ()

/** @property */
public void set_EraserMode (InkOverlayEraserMode value)
public function get EraserMode () : InkOverlayEraserMode

public function set EraserMode (value : InkOverlayEraserMode)
Not applicable.

Property Value

One of the InkOverlayEraserMode values indicates whether ink is erased by stroke or by point.

Remarks

This property applies only when the EditingMode property is set to Delete.

When erasing in InkOverlayEraserMode mode, strokes are often split into multiple smaller strokes.

Example

This C# example shows functions that are called when a user clicks menu items in order to change the eraser mode of an InkOverlay object, theInkOverlay.

private void menuItemStroke_Click(object sender, System.EventArgs e)
{
    theInkOverlay.EraserMode = InkOverlayEraserMode.StrokeErase;
    menuItemStroke.Checked = true;
    menuItemPoint.Checked = false;
}

private void menuItemPoint_Click(object sender, System.EventArgs e)
{
    theInkOverlay.EraserMode = InkOverlayEraserMode.PointErase;
    menuItemStroke.Checked = false;
    menuItemPoint.Checked = true;
}

This Microsoft Visual Basic .NET example shows functions that are called when a user clicks menu items in order to change the eraser mode of an InkOverlay object, theInkOverlay.

Imports Microsoft.Ink
'...
Private Sub MenuItemEraseStrokes_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) _
Handles MenuItemStroke.Click
    theInkOverlay.EraserMode = InkOverlayEraserMode.StrokeErase
    MenuItemStroke.Checked = True
    MenuItemPoint.Checked = False
End Sub

Private Sub MenuItemPoint_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) _ 
Handles MenuItemPoint.Click
    theInkOverlay.EraserMode = InkOverlayEraserMode.PointErase
    MenuItemStroke.Checked = False
    MenuItemPoint.Checked = True
End Sub

Platforms

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

See Also

Reference

InkOverlay Class
InkOverlay Members
Microsoft.Ink Namespace
InkOverlayEraserMode
InkOverlay.EditingMode