ScrollToCaret Method

8.7C, PLBCMP GUI Only

The ScrollToCaret method moves the caret of the EDITTEXT, EDITNUMBER, or RICHEDITTEXT object into view. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. An EDITTEXT, EDITNUMBER or RICHEDITTEXT object that is accessed.

return

Optional. A Numeric Variable that indicates the success of the method.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. Upon completion, {return} will always contain a one (1) to indicate success.

2. The OVER and EOS Condition Flags are always cleared.

3. For improved performance in the Application Server environment, do not specify the optional return value unless needed.

4. When using the PL/B Web Server, this method is not supported.

See Also: Method Syntax, EDITTEXT Methods, EDITNUMBER Methods, RICHEDITTEXT Methods