ITrendCursor​.PenLabelWidth [Property][Get/Set]

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

Defined As

• [VBA] Double PenLabelWidth(pen As Object)

• [Cicode] REAL PenLabelWidth (OBJECT pen)

• [C++] HRESULT PenLabelWidth (IPen* pen, double labelWidth)

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 width is represented in pixels.

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 labelWidth As Double
`Getting Property value
labelWidth = cursor.PenLabelWidth(pen)
`Setting Property value (100)
cursor.PenLabelWidth(pen) = 100
End Sub

[Cicode]

FUNCTION Example(OBJECT hCursor, OBJECT hPen)
REAL labelWidth;
// Getting current property value
labelWidth = _ObjectCallMethod(hCursor , "get_PenLabelWidth", hPen);
// Setting Property to 100
_ObjectCallMethod(hCursor , "put_PenLabelWidth", hPen, 100);
END

See Also

ITrendCursor.PenLabelHeight [Property][Get/Set]

ITrendCursor.PenLabelX [Property][Get/Set]

ITrendCursor.PenLabelY [Property][Get/Set]