Erasing by Using the Pen

Erasing by Using the Pen

Description of erasing by using the pen.

If you choose to implement erasing in your application other than by using the InkOverlay object, you can do so by using one of the following two methods.

Using the Tip of the Pen

The tip of the tablet pen is generally used for handwriting and drawing; however, the tip can also be used to erase ink. To do so, the application must have an erase mode that users can employ. In this mode, use hit testing to determine which ink the cursor is moving over. You can set the erase mode to delete only the ink that the cursor passes over or whole strokes that intersect the path of the cursor, depending upon design or functional considerations.

For an example of how to use an erase mode to erase ink, see the Ink Erasing Sample.

Using the Top of the Pen

To implement erasing with the top of the tablet pen, your application must look for a change in the cursor. To look for the inverted cursor, listen for the CursorInRange event to determine when the cursor is within the context of your application. When the cursor is in range, look for the Inverted property on the Cursor object. If the Inverted property is true, perform hit testing to determine which ink the cursor is moving over. Erase either the ink or the strokes that intersect the path of the cursor, depending upon design or functional considerations.

For an example of how to use the top of the pen to erase ink, see the Ink Erasing Sample.

Determining if Erasing with the Top of the Pen Is Enabled

Users can use the top of the pen to erase ink in applications designed for Tablet PC, if their particular hardware allows for it. This functionality is accessed by a check box in the Pen buttons group box on the Pen Options tab of the Tablet and Pen Settings control panel dialog. To detect if the user has enabled erasing for the top of the pen, check the following registry subkey:

HKEY_CURRENT_USER\SOFTWARE\Microsoft\WISP\PEN\SysEventParameters

The EraseEnable entry of this subkey is of type REG_DWORD. The value of this entry is 1 for enabled, or 0 for disabled. Other values are reserved for future use.

If your application allows the top of the pen to be used for erasing, you should check and cache the value of the EraseEnable entry when:

• Your application launches.
• Any time your application receives focus after losing focus.

Use this cached value to modify the behavior of your application appropriately.

C#

The following C# example defines a GetEraseEnabled method that checks the value of the EraseEnable entry of the SysEventParameters subkey. The GetEraseEnabled method returns true if the value of the entry is 1; returns false if the value of the entry is 0; or throws an InvalidOperationException exception if the value of the entry is other than 1 or 0. The GetEraseEnabled method returns the expected value of true if either the subkey or the entry is not present.

private bool GetEraseEnabled()
{
    // 0 is disabled, 1 is enabled. The default is enabled
    const int Enabled = 1;
    const int Disabled = 0;
    const int DefaultValue = Enabled;

    // Constants for the registry subkey and the entry
    const string Subkey =
                @"SOFTWARE\Microsoft\WISP\PEN\SysEventParameters";
    const string KeyEntry = "EraseEnable";

    // Open the registry subkey.
    Microsoft.Win32.RegistryKey regKey =
        Microsoft.Win32.Registry.CurrentUser.OpenSubKey(Subkey);

    // Retrieve the value of the EraseEnable subkey entry. If either
    // the subkey or the entry does not exist, use the default value.
    object keyValue = (null == regKey) ? DefaultValue :
        regKey.GetValue(KeyEntry,DefaultValue);

    switch((int)keyValue)
    {
        case Enabled:
            // Return true if erasing on pen inversion is enabled.
            return true;
        case Disabled:
            // Return false if erasing on pen inversion is disabled.
            return false;
        default:
            // Otherwise, throw an exception. Do not assume this is
            // a Boolean value. Enabled and Disabled are the values
            // defined for this entry at this time. Other values are
            // reserved for future use.
            throw new InvalidOperationException(
                "Unexpected registry subkey value.");
    }
}