Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Plant SCADA

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

  • Last UpdatedJul 18, 2023
  • 1 minute read

Get or Set whether the cursor label positions are locked.

Defined As

  • [VBA] Boolean LabelsLocked

  • [Cicode] INT LabelsLocked

  • [C++] VARIANT_BOOL LabelsLocked

Limits

  • True (-1): Labels are locked

  • False (0): Labels are unlocked

Remarks

If labels are locked, they will not move when the cursor position is changed.

Calling Syntax

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

[VBA]

Sub Example(cursor As Object)
Dim labelsLocked As Boolean
`Getting Property value
labelsLocked = cursor.LabelsLocked
`Setting Property value (False)
cursor.LabelsLocked = False
End Sub

[Cicode]

FUNCTION Example(OBJECT hCursor)
INT labelsLocked;
// Getting current property value
labelsLocked = _ObjectGetProperty(hCursor, "LabelsLocked");
// Setting Property to False (0)
_ObjectSetProperty(hCursor, "LabelsLocked", 0);
END

In This Topic
TitleResults for “How to create a CRG?”Also Available in