ITrendCursor.PenLabelHeight [Property][Get/Set]

Get or Set the label height of the specified pen on this cursor.

Defined As

• [VBA] Double PenLabelHeight(pen As Object)
• [Cicode] REAL PenLabelHeight (OBJECT pen)
• [C++] HRESULT PenLabelHeight (IPen* pen, double labelHeight)

Parameters

pen

[in] The pen for which cursor label is to be referenced.

Execution Result

If the property get/set succeeds the return value will be Success. If the return variable is bad then the return value will be InvalidArgument. If the cursor is deleted the return value will be GeneralFailure.

Remarks

The value of height is represented in pixels.

See Also

ITrendCursor.PenLabelWidth [Property][Get/Set], ITrendCursor.PenLabelX [Property][Get/Set], ITrendCursor.PenLabelY [Property][Get/Set]

Calling Syntax

This example assumes you have a valid reference to a cursor and a pen.

[VBA]

Sub Example(cursor As Object, pen As Object)

	 Dim labelHeight As Double

 `Getting Property value

   labelHeight = cursor.PenLabelHeight(pen)

  `Setting Property value (100)

	 cursor.PenLabelHeight (pen) = 100

End Sub

[Cicode]

FUNCTION Example(OBJECT hCursor, OBJECT hPen)

	REAL labelHeight;

 // Getting current property value

 labelHeight = _ObjectCallMethod(hCursor , "get_PenLabelHeight", hPen);

	// Setting Property to 100

		_ObjectCallMethod(hCursor , "put_PenLabelHeight", hPen, 100);

END