IProcessAnalyst​.LockedPens [Property][Get/Set]

Determines whether every the pen across every pane in the Process Analyst control are locked together.

Defined As

• [VBA] Boolean LockedPens

• [Cicode] INT LockedPens

• [C++] VARIANT_BOOL LockedPens

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.

Remarks

While this property is enabled, any operation applied to the selected pen is applied to every pen. When the property is disabled, the pens will lose the lock logic, and any interaction technique will apply to the individual pen with selection focus.

If this property is disabled and then enabled, every pen assumes the same scale, timespan, and end time position as the selected pen.

Limits

• True (-1): Pens are locked.

• False (0): Pens are unlocked.

Calling Syntax

Assumes you have a page called "myPage" and the Process Analyst has been named "AN35".

[VBA]

Sub Example()
Dim locked As Boolean
`Get current locked status
locked = myPage_AN35.LockedPens
`Turn off locked Pens
myPage_AN35.LockedPens = False
End Sub

[Cicode]

FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName("AN35");
OBJECT lockedPens;
// Get current locked status
lockedPens = _ObjectGetProperty(hProcessAnalyst, "LockedPens");
// Turn off locked Pens
_ObjectSetProperty(hProcessAnalyst, "LockedPens", 0);
END