InkPicture.Ink property

Gets or sets the InkDisp object that is associated with the InkPicture control.

This property is read/write.

Syntax


HRESULT put_Ink(
  [in]          InkDisp *NewInk
);

HRESULT get_Ink(
  [out, retval] InkDisp **Ink
);

Property value

The InkDisp object that is associated with an InkCollector object or an InkPicture control.

Error codes

NameMeaning
S_OK

Success.

E_POINTER

The Ink parameter must be a valid pointer to an Ink pointer.

E_INK_COLLECTOR_ENABLED

Cannot change Ink object while collecting.

E_INK_EXCEPTION

An exception occurred inside the method.

E_INVALIDARG

Invalid hWnd value.

Remarks

Note  The InkPicture control must be disabled before setting this property. To disable inking in the InkPicture control, set the InkEnabled property to FALSE. You can then set the Ink property, and re-enable the control by setting the InkEnabled property to TRUE.
 

For further details about this property, refer to the InkOverlay object's Ink 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
InkDisp Class

 

 

Show: