InkDrawingAttributes.Height property

Gets or sets the height of the pen when drawing ink with the InkDrawingAttributes object.

This property is read/write.

Syntax


HRESULT put_Height(
  [in]          float NewHeight
);

HRESULT get_Height(
  [out, retval] float *CurrentHeight
);

Property value

Sets a single-precision number that indicates the height of the pen. The default pen height is 1 (in ink space units).

Error codes

NameMeaning
S_OK

Success.

E_POINTER

Parameter pointer was NULL or invalid.

E_INK_EXCEPTION

An exception occurred inside the method.

E_INVALIDARG

The height of the pen cannot be less than 0.

Remarks

This property applies only to the Rectangle pen tip. The value represents the height of the side of the rectangle. If using the Ball pen tip then the height of the pen tip is equal to the Width property, and the Height property is ignored.

Precision is limited to 1/1000 (three digits to the right of the decimal point). For example, if you specify a value of 2.0006, the most precise measurement is 2.001.

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

InkDrawingAttributes Class
InkPenTip Enumeration
PenTip Property
Width Property [InkDrawingAttributes Class]

 

 

Show: