IInkCustomStrokes interface

Contains a collection of user-defined InkStrokes collections.

Members

The IInkCustomStrokes interface inherits from the IUnknown interface. IInkCustomStrokes also has these types of members:

Methods

The IInkCustomStrokes interface has these methods.

MethodDescription
Add

Specifies the collection of strokes to add to the collection of custom strokes.

Clear

Specifies that all custom strokes are cleared from the collection.

Item

Retrieves the InkStrokes Collection at the location specified within the IInkCustomStrokes.

Remove

Specifies the collection of strokes to remove from the known collection of custom strokes.

 

Properties

The IInkCustomStrokes interface has these properties.

PropertyAccess typeDescription

_NewEnum

Gets either the IEnumVARIANT or IEnumUnknown enumerator interface for the collection. Use this property to retrieve each object in the collection.

The _NewEnum property is marked restricted in the Interface Definition Language (IDL) definition for the collection interfaces.

Count

Read-only

Gets the number of InkStrokes collections within the collection of custom strokes.

 

Remarks

The custom strokes are essentially named InkStrokes collections that are persisted and recalled for later use.

You use a collection of custom strokes to store strokes that have the same meaning or that are related in some way. Examples of strokes that you may want to persist include:

  • All the strokes drawn by the same cursor (pen)
  • The strokes in an InkDisp object that correspond to a word or paragraph
  • All the strokes that intersect a known region

For example, suppose you want to draw with two different cursors and keep separate the set of strokes that you draw with each cursor. You could recognize the strokes drawn with the first cursor and attach an IInkRecognitionResult object to that collection of strokes. To persist the recognition result, add the strokes to the CustomStrokes collection of the InkDisp object. You can later access the first collection of strokes by getting the persisted CustomStrokes collection from the InkDisp object.

Each IInkCustomStrokes collection is referenced by name.

IInkCustomStrokes collections are references to ink data, not the actual data itself.

For more information about collections in COM, see Using the COM Library.

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

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

InkDisp Class
InkStrokes Collection

 

 

Show: