IInkPicture::get_Cursors method (msinkaut.h)

Article
02/22/2024

Gets the collection of cursors that are available for use in the inking region. Each cursor corresponds to the tip of a pen or other ink input device.

This property is read-only.

Syntax

HRESULT get_Cursors(
  IInkCursors **Cursors
);

Parameters

Cursors

Return value

None

Remarks

Cursors are local to an InkCollector object.

Any new cursors that the InkCollector encounters are added to the returned collection of cursors, although the returned cursors are not necessarily returned in the order in which the InkCollector encounters them.

When a mouse is enabled as an input device on the InkCollector (when the useMouse parameter of the SetAllTabletsMode method is TRUE), the mouse is added to the IInkCursors collection after the InkCollector encounters any other cursor, such as a pen. This is because the pen also acts like a mouse.

Note The CursorInRange event is received for the mouse cursor after any other cursor, such as a pen, draws a stroke (which fires the Stroke event).

The IInkCursors collection is reset (count set to 0, containing no objects) when:

The tablet mode is changed (for example, from SetSingleTabletIntegratedMode to SetAllTabletsMode).
The SetSingleTabletIntegratedMode method is called.

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