InkPicture.CollectionMode property

Gets or sets the collection mode that determines whether ink, gestures, or both are recognized as the user writes.

This property is read/write.

Syntax


HRESULT put_CollectionMode(
  [in]          InkCollectionMode Mode
);

HRESULT get_CollectionMode(
  [out, retval] InkCollectionMode *Mode
);

Property value

The collection mode that determines whether ink, gestures, or both are recognized as the user writes.

The default value is InkOnly, which specifies that only ink is collected.

Error codes

NameMeaning
S_OK

Success.

E_POINTER

The CollectionMode parameter is an invalid pointer.

E_INK_EXCEPTION

An exception occurred inside the method.

E_INVALIDARG

The specified mode is invalid.

Remarks

For a list of the modes that you can use, see the InkCollectionMode enumeration type.

For further details about this property, refer to the InkCollector object's CollectionMode property, which has the same functionality.

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

InkPicture
InkPicture Control
InkCollectionMode Enumeration
CollectingInk Property

 

 

Show: