IInkCursor::DrawingAttributes property

Gets or sets the drawing attributes to apply to ink as it is drawn.

This property is read/write.

Syntax


HRESULT get_DrawingAttributes(
  [out, retval] InkDrawingAttributes **DrawingAttributes
);

Property value

Error codes

NameMeaning
S_OK

Success. The parameter contains the attributes that you set for the known cursor.

E_FAIL

An unspecified error occurred.

E_INK_EXCEPTION

An exception occurred while processing.

E_OUTOFMEMORY

Cannot allocate memory to store the drawing attributes.

E_POINTER

A parameter contains an invalid pointer.

E_UNEXPECTED

Unexpected parameter or property type.

REGDB_CLASSNOTREG

The InkDrawingAttributes object was not registered.

Remarks

The drawing attributes specify the appearance of the stroke. For example, you can specify the style and color of a pen.

A cursor can have different drawing attributes for each InkCollector with which it comes in contact. If you do not specify drawing attributes for a cursor, it uses the default drawing attributes of the InkCollector object. These default attributes are set with the DefaultDrawingAttributes property of the InkCollector object.

Successive calls to the DrawingAttributes property change only the drawing attributes of new strokes. They do not apply to strokes that are already collected or being collected.

Note  This property behaves differently than the DefaultDrawingAttributes property. Although the DefaultDrawingAttributes property specifies the drawing attributes that are applied to a new cursor, the DrawingAttributes property specifies the drawing attributes for ink that is yet to be collected.
 

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

InkCursor Interface
DefaultDrawingAttributes Property
InkDrawingAttributes Class
InkCollector Class

 

 

Show: