InkPicture.EditingMode Property

Article
12/12/2007

Gets or sets a value that indicates whether the InkPicture is in ink mode, delete mode, or select/edit mode.

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

Syntax

'Declaration
Public Property EditingMode As InkOverlayEditingMode
'Usage
Dim instance As InkPicture
Dim value As InkOverlayEditingMode

value = instance.EditingMode

instance.EditingMode = value

public InkOverlayEditingMode EditingMode { get; set; }

public:
property InkOverlayEditingMode EditingMode {
    InkOverlayEditingMode get ();
    void set (InkOverlayEditingMode value);
}

/** @property */
public InkOverlayEditingMode get_EditingMode ()

/** @property */
public void set_EditingMode (InkOverlayEditingMode value)

public function get EditingMode () : InkOverlayEditingMode

public function set EditingMode (value : InkOverlayEditingMode)

Not applicable.

Property Value

One of the InkOverlayEditingMode values.

Remarks

An error is generated if you change the EditingMode property while ink is being collected. To avoid this conflict, make sure the CollectingInk property is false before changing the EditingMode property.

For more information about erasing ink, see Erasing Ink with the Pen.

Example

This C# example shows functions that are called when menu items are clicked in order to change the editing mode of an InkPicture, theInkPicture.

[C#]

private void menuItemInk_Click(object sender, System.EventArgs e)
{
    if (!theInkPicture.CollectingInk)
    {
        theInkPicture.EditingMode = InkOverlayEditingMode.Ink;
        menuItemInk.Checked = true;
        menuItemDelete.Checked = false;
        menuItemSelect.Checked = false;
    }
    else
    {
        // Unlikely to happen, but check anyway
        MessageBox.Show("Cannot change modes while collecting ink");
    }
}

private void menuItemDelete_Click(object sender, System.EventArgs e)
{
    if (!theInkPicture.CollectingInk)
    {
        theInkPicture.EditingMode = InkOverlayEditingMode.Delete;
        menuItemInk.Checked = false;
        menuItemDelete.Checked = true;
        menuItemSelect.Checked = false;
    }
    else
    {
        // Unlikely to happen, but check anyway
        MessageBox.Show("Cannot change modes while collecting ink");
    }
}

private void menuItemSelect_Click(object sender, System.EventArgs e)
{
    if (!theInkPicture.CollectingInk)
    {
        theInkPicture.EditingMode = InkOverlayEditingMode.Select;
        menuItemInk.Checked = false;
        menuItemDelete.Checked = false;
        menuItemSelect.Checked = true;
    }
    else
    {
        // Unlikely to happen, but check anyway
        MessageBox.Show("Cannot change modes while collecting ink");
    }
}

This Microsoft® Visual Basic® .NET example shows functions that are called when menu items are clicked in order to change the editing mode of an InkPicture, theInkPicture.

[Visual Basic]

Imports Microsoft.Ink
'...
Private Sub MenuItemInk_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) _
Handles MenuItemInk.Click
    If theInkPicture.CollectingInk = False Then
        theInkPicture.EditingMode = InkOverlayEditingMode.Ink
        MenuItemInk.Checked = True
        MenuItemDelete.Checked = False
        MenuItemSelect.Checked = False
    Else
        'Unlikely to happen, but check anyway
        MessageBox.Show("Cannot change modes while collecting ink")
    End If
End Sub

Private Sub MenuItemDelete_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) _
Handles MenuItemDelete.Click
    If theInkPicture.CollectingInk = False Then
        theInkPicture.EditingMode = InkOverlayEditingMode.Delete
        MenuItemInk.Checked = False
        MenuItemDelete.Checked = True
        MenuItemSelect.Checked = False
    Else
        'Unlikely to happen, but check anyway
        MessageBox.Show("Cannot change modes while collecting ink")
    End If
End Sub

Private Sub MenuItemSelect_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) _
Handles MenuItemSelect.Click
    If theInkPicture.CollectingInk = False Then
        theInkPicture.EditingMode = InkOverlayEditingMode.Select
        MenuItemInk.Checked = False
        MenuItemDelete.Checked = False
        MenuItemSelect.Checked = True
    Else
        'Unlikely to happen, but check anyway
        MessageBox.Show("Cannot change modes while collecting ink")
    End If
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

Share via