IInkStrokeDisp::DrawingAttributes
4/8/2010
Returns or sets the drawing attributes to apply to the ink of an IInkStrokeDisp object as it is drawn.
Syntax
[propputref] HRESULT putref_DrawingAttributes (
[in] InkDrawingAttributes *DrawingAttributes);
[propget] HRESULT get_DrawingAttributes (
[out, retval] InkDrawingAttributes **DrawingAttributes);
Parameters
DrawingAttributes
Returns or sets the IInkDrawingAttributes object that determines the attributes to apply to ink as it is drawn. If this object is NULL, the cursor uses the default drawing attributes of the IInkOverlay object.This property is read/write.
Return Value
HRESULT value | Description |
---|---|
S_OK |
Success. The parameter contains the attributes that you set for the known cursor. |
E_OUTOFMEMORY |
Cannot allocate memory to store the drawing attributes. |
E_INK_EXCEPTION |
An exception occurred while processing. |
E_POINTER |
A parameter contains an invalid pointer. |
E_FAIL |
An unspecified error occurred. |
E_UNEXPECTED |
Unexpected parameter or property type. |
REGDB_CLASSNOTREG |
The IInkDrawingAttributes 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.
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 IInkOverlay::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
Header | msinkaut.h |
Windows Embedded CE | Windows CE 5.0 and later |
Windows Mobile | Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later |