InkOverlay.Enabled Property

InkOverlay.Enabled Property

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

Definition

Visual Basic .NET Public Property Enabled As Boolean
C# public bool Enabled { get; set; }
Managed C++ public: __property bool* get_Enabled();
public: __property void set_Enabled(bool*);

Property Value

System.Boolean. Whether or not the InkOverlay object collects pen input.

This property is read/write.

trueDefault. The InkOverlay object collects pen input.
falseThe InkOverlay object does not report pen input. No pen-related events fire.

Exceptions

COMException Leave Site:
ObjectDisposedException Leave Site:

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® 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 Enabled 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 InkOverlay, a COMException Leave Site 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:

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

Examples

[C#]

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


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

[VB.NET]

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
'...
			

See Also

Show: