Export (0) Print
Expand All
Expand Minimize

InkOverlay.Cursors property

Applies to: desktop apps only

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(
  [out, retval]  IInkCursors **Cursors
);

Property value

A pointer to the collection of cursors that this InkCollector has encountered.

Error codes

NameMeaning
S_OK

Success.

E_POINTER

The Cursors parameter must be a valid pointer to an IInkCursors pointer.

E_FAIL

An unspecified error occurred.

E_INK_EXCEPTION

An exception occurred inside the method.

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:

Requirements

Minimum supported client

Windows XP Tablet PC Edition

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

InkOverlay Class
MouseIcon Property
MousePointer Property
SetAllTabletsMode Method
SetSingleTabletIntegratedMode Method
IInkCursors Interface

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2014 Microsoft