InkDisp.InkAdded event

Applies to: desktop apps only

Occurs when a stroke is added to the InkDisp object.

Syntax

void InkAdded(
  [in]  VARIANT StrokeIds
);

Parameters

StrokeIds [in]

The integer array of stroke ID information for all of the strokes that have been added when this event occurs.

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

Return value

This event does not return a value.

Remarks

If you use the InkOverlay object or the InkPicture control (where EditingMode equals Delete and EraserMode equals StrokeErase) and pass the eraser over a stroke, you get the following sequence of events:

The additional InkAdded and InkDeleted events occur because the underlying code adds an internal, invisible stroke to track the eraser.

This event method is defined in the _IInkEvents interface. The _IInkEvents interface implements the IDispatch interface with an identifier of DISPID_IEInkAdded.

The InkAdded event is fired even when in select or erase mode, not just when inserting ink. This requires that you monitor the editing mode (which you are responsible for setting) and be aware of the mode before interpreting the event. The advantage of this requirement is greater freedom to innovate on the platform through greater awareness of platform events.

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

InkDisp Class
EditingMode Property [InkOverlay Class]
EraserMode Property [InkOverlay Class]
InkDeleted Event
InkOverlay Class
InkPicture Control Reference
IInkStrokeDisp Interface

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2014 Microsoft