InkOverlay.CursorButtonDown event

Article
04/27/2021

Occurs when the InkCollector Class detects a cursor button that is down.

Syntax

void CursorButtonDown(
  [in] IInkCursor       *Cursor,
  [in] IInkCursorButton *Button
);

Parameters

Cursor [in]: The IInkCursor object that generated the CursorButtonDown event.
Button [in]: The button that was pressed.

Return value

This event does not return a value.

Remarks

A button on a pen tip is down when the user lowers the pen to the digitizer and starts tracing a stroke. A button on a barrel is down when the button is pressed.

When you press the right mouse button, you actually receive two CursorButtonDown events - one for right button pressed and one for left button pressed.

This event method is defined in the _IInkCollectorEvents, _IInkOverlayEvents, and _IInkPictureEvents dispatch-only interfaces (dispinterfaces) with an ID of DISPID_ICECursorButtonDown.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Header	Msinkaut.h (also requires Msinkaut_i.c)
Library	InkObj.dll