IPen​.VerticalScrollBy [Method]

Scrolls the vertical axis by the specified factor.

Defined As

• [VBA] VerticalScrollBy(factor As Double)

• [Cicode] VerticalScrollBy(REAL factor)

• [C++] HRESULT VerticalScrollBy(double factor)

Parameters

factor

[in] Controls the direction and amount the axis will be scrolled. A negative value will move the axis in the negative direction. A positive value will move the axis forward in the positive direction. The value is a percentage representing the current viewable span. So if the pen span is 100 units (10 to 110), and you specify a factor of 0.5 then you will move the span 50 units (60 to 160).

Execution Result

If the function succeeds the return value will be Success. If the argument is bad then the return value will be InvalidArgument. If the pen is deleted then the return value will be GeneralFailure.

Calling Syntax

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

[VBA]

Sub Example(pen As Object)
` Move the pen span forward one complete span
pen.VerticalScrollBy 1.0
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
// Move the pen span forward one complete span
_ObjectCallMethod(hPen, "VerticalScrollby", 1.0);
END

See Also

IPen.HorizontalScrollBy [Method]