InkCollector.Gesture event

Article
04/27/2021

Occurs when an application-specific gesture is recognized.

Syntax

void Gesture(
  [in]      IInkCursor   *Cursor,
  [in]      IInkStrokes  *Strokes,
  [in]      VARIANT      Gestures,
  [in, out] VARIANT_BOOL *Cancel
);

Parameters

Cursor [in]

The IInkCursor object that generated the Gesture event.

Strokes [in]

The IInkStrokes collection that the recognizer returned as the gesture.

Gestures [in]

An array of IInkGesture objects, in order of confidence, from the recognizer.

For more information about the VARIANT structure, see Using the COM Library.

Cancel [in, out]

VARIANT_TRUE if this gesture should be cancelled; otherwise, VARIANT_FALSE.

Return value

This event does not return a value.

Remarks

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

When the CollectionMode property is set to GestureOnly, the timeout between when a user adds a gesture and when the Gesture event occurs is a fixed value that you cannot alter programmatically. Gesture recognition is faster in InkAndGesture mode.

To prevent the collection of ink while in InkAndGesture mode:

Set CollectionMode to InkAndGesture.
Delete the stroke in the Stroke event.
Process the gesture in the Gesture event.

To prevent the flow of ink while gesturing, set DynamicRendering property to FALSE.

In addition to when inserting ink, the Gesture event is fired when in select or erase mode. You are responsible for tracking the editing mode and should be aware of the mode before interpreting the event.

Note

To recognize gestures, you must use an object or control that can collect ink.

Application gestures are defined as gestures that are supported within your application.

For this event to occur, the object or control must have interest in a set of application gestures. To set the objects or controls interest in a set of gestures, call the SetGestureStatus method of the object or control.

For a list of specific application gestures, see the InkApplicationGesture enumeration type.

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