InkOverlay.Enabled Property

Article
12/12/2007

Gets or sets a value that specifies whether the InkOverlay object collects pen input.

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

Syntax

'Declaration
Public Property Enabled As Boolean
'Usage
Dim instance As InkOverlay
Dim value As Boolean

value = instance.Enabled

instance.Enabled = value

public bool Enabled { get; set; }

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

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

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

public function get Enabled () : boolean

public function set Enabled (value : boolean)

Not applicable.

Property Value

Whether or not the InkOverlay object collects pen input. true if the InkOverlay object collects pen input. false if the InkOverlay object 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 InkOverlay object collects ink in Microsoft Windows Vista, 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 starting with 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 Enabled property is 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 InkOverlay, a COMExceptionCOMException 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 Enabled property to false while the object is collecting ink (CollectingInk property is true.).

The Enabled property must be set to false before setting or calling specific properties and methods of the object. 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 Enabled property is first set to false:

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

You should set the Enabled property for an InkOverlay object to false before you shut down an application.

Example

This C# example creates an InkOverlay object and enables it.

using Microsoft.Ink;
//...
InkOverlay theInkOverlay = new InkOverlay(Handle);
theInkOverlay.Enabled = true;
//...

This Microsoft Visual Basic .NET example creates an InkOverlay object and enables it.

Imports Microsoft.Ink
'...
Dim theInkOverlay As New InkOverlay(Handle)
theInkOverlay.Enabled() = True
'...

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