InkPicture.InkEnabled Property

Article
12/12/2007

Gets or sets a value that specifies whether the InkPicture control collects pen input.

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

Syntax

'Declaration
Public Property InkEnabled As Boolean
'Usage
Dim instance As InkPicture
Dim value As Boolean

value = instance.InkEnabled

instance.InkEnabled = value

public bool InkEnabled { get; set; }

public:
property bool InkEnabled {
    bool get ();
    void set (bool value);
}

/** @property */
public boolean get_InkEnabled ()

/** @property */
public void set_InkEnabled (boolean value)

public function get InkEnabled () : boolean

public function set InkEnabled (value : boolean)

Not applicable.

Property Value

true if the InkPicture control collects pen input. Default. false if the InkPicture control does not report pen input. No pen-related events fire.

Remarks

In addition to ink, pen input may include in-air packets, cursor in range events, and so on.

The InkPicture control collects ink in Microsoft® Windows® XP Tablet PC Edition or any edition of Windows 2000, Windows Server 2003, or Windows XP on which the Windows XP Tablet PC Edition SDK is installed. However, handwriting recognition occurs only if you use Windows XP Tablet PC Edition. In any edition of Windows 2000, Windows Server 2003, or of Windows XP other than Windows XP Tablet PC Edition, the InkEnabled property is always false if the Windows XP Tablet PC Edition SDK is not installed.

If the window input rectangle of an enabled InkCollector or InkOverlay (set in the constructor or with the SetWindowInputRectangle method) overlaps the window input rectangle of an InkPicture, a COMException exception is thrown.

Note

Overlap can occur without an error as long as only one of the input rectangles is enabled at anytime.

While a control is not enabled, you receive no events.

When you set the Enabled property of a container control to false, all of its contained controls are disabled as well.

You cannot set the InkEnabled property to false while the control is collecting ink (CollectingInk property is true.).

The InkEnabled property must be set to false before setting or calling specific properties and methods of the control. If you try to change the specified properties or call the specified methods, an error occurs.

The following properties and methods cannot be set or called unless the InkEnabled property is first set to false:

Properties:
- Ink
- MarginX
- MarginY
Methods:
- SetAllTabletsMode
- SetSingleTabletIntegratedMode

You should set the InkEnabled property for an InkPicture control to false before you shut down an application.

Example

This C# example is an event handler for a button click event for a form on which two controls are defined, an InkPicture control, theInkPicture, and a Button control, theButton. The event handler updates the InkEnabled property value based on the current state of the property. The event handler also updates the text of the button to reflect what the next click of the button will do.

[C#]

// Event handler for the button's Click event.
private void theButton_Click(object sender, System.EventArgs e)
{
    // Enable or disable ink collection on the InkPicture control
    // and update the button text.
    if (theInkPicture.Enabled)
    {
        theInkPicture.Enabled = false;
        theButton.Text = "Enable ink collection";
    }
    else
    {
        theInkPicture.Enabled = true;
        theButton.Text = "Disable ink collection";
    }
}

This Microsoft Visual Basic® .NET example is an event handler for a button click event for a form on which two controls are defined, an InkPicture control, theInkPicture, and a Button control, theButton. The event handler updates the InkEnabled property value based on the current state of the property. The event handler also updates the text of the button to reflect what the next click of the button will do.

[Visual Basic]

' Event handler for the button's Click event.
Private Sub theButton_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles theButton.Click

    ' Enable or disable ink collection on the InkPicture control
    ' and update the button text.
    If (theInkPicture.Enabled) Then
        theInkPicture.Enabled = False
        theButton.Text = "Enable ink collection"
    Else
        theInkPicture.Enabled = True
        theButton.Text = "Disable ink collection"
    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