IPen​.HorizontalScrollBy [Method]

Scrolls the horizontal axis by the specified factor.

Defined As

• [VBA] HorizontalScrollBy(factor As Double)

• [Cicode] HorizontalScrollBy(REAL factor)

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

Parameters

factor

[in] Controls the direction and amount the axis will be scrolled. A negative value will move the axis back in time; a positive value will move the axis forward in time. The value is a percentage representing the current viewable span. So if the pen span is 1 hour, and you specify a factor of 0.5, you will move the time span 30 minutes into the future.

Execution Result

If the function succeeds, the return value will be Success. If the argument is bad, the return value will be InvalidArgument. If the pen is deleted, 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 back one complete span into history
pen.HorizontalScrollBy -1.0
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
// Move the pen span back one complete span into history
_ObjectCallMethod(hPen, "HorizontalScrollby", -1.0);
END

See Also

IPen.VerticalScrollBy [Method]