Cicode Programming Reference > Cicode Function Categories > Display Functions Introduction > DspRichTextPgScroll

DspRichTextPgScroll

Scrolls the contents of the rich text object displayed at AN, by one page length in the direction given in direction.

Syntax

DspRichTextPgScroll(AN, iDirection)

AN:

The reference AN for the rich text object.

iDirection:

The direction in which you want to scroll each time this function is run. You can choose from the following:

1 - Left

2 - Right

3 - Up

4 - Down

8 - Scroll to top

16 - Scroll to bottom

Return Value

0 if successful, otherwise an error is returned.

Related Functions

PageRichTextFile, DspRichTextEdit, DspRichTextScroll

Example

// This line scrolls the contents of the rich text object at AN 25
down one page. Otherwise an error will be returned to iResult //
iResult = DspRichTextPgScroll(25,4);
// This line scrolls the contents of the rich text object at AN 423
right one page. Otherwise an error will be returned to iResult //
iResult = DspRichTextPgScroll(423,2);

See Also

Display Functions