Get or Set the label visibility of the specified pen on this cursor.
Defined As
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, the return value will be InvalidArgument. If the cursor is deleted, the return value will be GeneralFailure.
Limits
Remarks
Setting the visibility of the cursor using the Visible property will override the pen label visibility. For example, if a particular label is hidden using PenLabelVisible, this label will be shown again if Visible is set to True (-1).
See Also
ITrendCursor.Visible [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 labelVisible As Boolean
`Getting Property value
labelVisible = cursor.PenLabelVisible(pen)
`Setting Property value (False)
cursor.PenLabelVisible(pen) = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor, OBJECT hPen)
INT labelVisible;
// Getting current property value
labelVisible = _ObjectCallMethod(hCursor, "get_PenLabelVisible", hPen);
// Setting Property to FALSE
_ObjectCallMethod(hCursor , "put_PenLabelVisible", hPen, 0);
END