Scroll

Description

Scrolls a multiline edit control or the edit control of a DataWindow a specified number of lines up or down.

Applies to

DataWindow, MultiLineEdit, and RichTextEdit controls

Syntax

editname.Scroll ( number )

Argument

Description

editname

The name of the DataWindow, RichTextEdit, or MultiLineEdit in which you want to scroll up or down. If editname is a DataWindow, then Scroll affects its edit control.

number

A long specifying the direction and number of lines you want to scroll. To scroll down, use a positive long value. To scroll up, use a negative long value.


Return value

Long.

For RichTextEdit controls, Scroll returns 1 if it succeeds. For other controls, Scroll returns the line number of the first visible line in editname if it succeeds. Scroll returns -1 if an error occurs. If any argument's value is null, Scroll returns null.

Usage

If the number of lines left in the list is less than the number of lines that you want to scroll, then Scroll scrolls to the beginning or end, depending on the direction specified.

Examples

This statement scrolls mle_Employee down 4 lines:

mle_Employee.Scroll(4)

This statement scrolls mle_Employee up 4 lines:

mle_Employee.Scroll(-4)

See also

The following functions implement scrolling in a DataWindow or a RichTextEdit:

ScrollNextPage

ScrollNextRow

ScrollPriorPage

ScrollPriorRow

ScrollToRow