IInkOverlay::put_Enabled method (msinkaut.h)

Gets or sets a value that specifies whether the InkOverlay object collects pen input (in-air packets, cursor in range events, and so on).

This property is read/write.

Syntax

HRESULT put_Enabled(
  VARIANT_BOOL Collecting
);

Parameters

Collecting

Return value

None

Remarks

If an enabled object's window input rectangle (set in the constructor or with the SetWindowInputRectangle method) of an enabled object overlaps the window input rectangle of another enabled object, the E_INK_OVERLAPPING_INPUT_RECT error is returned. Overlap can occur without an error as long as only one of the input rectangles is enabled at any known time.

While an object is not enabled, you receive no events.

When a container control has its Enabled property set 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).

We recommend that you set Enabled set to FALSE when the application shuts down.

Note  Setting this property within certain message handlers can result in the underlying function being re-entered, causing unexpected results. Take care to avoid a reentrant call when handling any of the following messages: WM_ACTIVATE, WM_ACTIVATEAPP, WM_NCACTIVATE, WM_PAINT; WM_SYSCOMMAND if wParam is set to SC_HOTKEY or SC_TASKLIST; and WM_SYSKEYDOWN (when processing Alt-Tab or Alt-Esc key combinations). This is an issue with single-threaded apartment model applications.

 

This 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 methods, an error occurs. The following properties and methods cannot be set or called unless the Enabled property is first set to FALSE:

Properties

• AttachMode
• hWnd
• Ink
• MarginX
• MarginY

Methods

• SetAllTabletsMode
• SetSingleTabletIntegratedMode

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	msinkaut.h
Library	InkObj.dll

See also

AttachMode Property

CollectingInk Property

CollectionMode Property [InkCollector Class]

EditingMode Property [InkOverlay Class]

IInkOverlay

Ink

InkOverlay Class

MarginX Property

MarginY Property

SetAllTabletsMode Method

SetSingleTabletIntegratedMode Method

SetWindowInputRectangle Method

hWnd Property