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

AVEVA™ Plant SCADA

IPen​.VerticalAxisScroll [Property][Get/Set]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Gets or sets whether this pen allows the operator to interactively scroll the vertical axis by using the mouse.

Defined As

  • [VBA] Boolean VerticalAxisScroll

  • [Cicode] INT VerticalAxisScroll

  • [C++] VARIANT_BOOL VerticalAxisScroll

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 pen is deleted, the return value will be GeneralFailure.

Limits

  • True (-1): Enable scrolling

  • False (0): Disable scrolling

Remarks

This only applies to analog pens.

Calling Syntax

Assumes you have passed a valid pen object into the function.

[VBA]

Sub Example(pen As Object)
Dim scroll As Boolean
`Getting Property value
scroll = pen.VerticalAxisScroll
`Setting Property value
pen.VerticalAxisScroll = False
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
INT bScroll;
// Getting current property value
bScroll = _ObjectGetProperty(hPen, "VerticalAxisScroll");
// Setting Property
_ObjectSetProperty(hPen, "VerticalAxisScroll", 0);
END

See Also

IPen.HorizontalAxisScroll [Property][Get/Set]

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