IInkCursor interface

Represents general information about the tablet cursor.

Methods

The IInkCursor interface has these methods.

Method Description
IInkCursor::get_Buttons Gets the IInkCursorButtons collection that is available on an IInkCursor.
IInkCursor::get_DrawingAttributes Gets or sets the drawing attributes to apply to ink as it is drawn.
IInkCursor::get_Id Gets the identifier of an object.
IInkCursor::get_Inverted Gets a value that indicates whether the cursor is the inverted end of the pen.
IInkCursor::get_Name Gets the name of the object.
IInkCursor::get_Tablet Gets either the IInkTablet object to which a cursor belongs or the IInkTablet object that an object or control is currently using to collect input.
IInkCursor::putref_DrawingAttributes Gets or sets the drawing attributes to apply to ink as it is drawn.

Remarks

An IInkCursor object represents the physical pen that the user holds. Physical pens may have multiple tips - such as normal and eraser ends - with each pen tip representing a different IInkCursor object. Some Tablet PCs allow multiple pens. Each cursor has an associated identifier that is unique on a system. For more information about how pens can be used with Tablet PC, see Pen Input, Ink, and Recognition.

A specific set of drawing attributes can be assigned to a known cursor, such as whether the pen color should be red or blue. A cursor also contains a collection of zero or more IInkCursorButton objects.

Cursors exist only within the scope of an InkCollector object, an InkOverlay object, or an InkPicture control. When one of these objects encounters a new cursor, the object fires its CursorInRange event with the newCursor parameter set to TRUE. This allows you to set up properties in the application, such as drawing attributes, when the cursor is first encountered. The Cursors property contains the collection of cursors that the object or control has encountered.

An IInkCursor cannot be constructed explicitly. Instead, you obtain an IInkCursor from either events or the Cursors property of an InkCollector object, an InkOverlay object, or an InkPicture control.

If you define a class that implements this interface, the new class will not interact correctly with the Tablet PC application programming interfaces (APIs).

Requirements

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

See also

Cursors Property

IInkCursorButton Interface

IInkCursorButtons Interface

IInkCursors Interface

IInkTablet Interface

InkCollector Class

InkDrawingAttributes Class

InkOverlay Class

InkPicture Control Reference