LineIndex Method

8.7C, PLBCMP GUI Only

The LineIndex method retrieves the character index of the first character of a specified line in a multiline EDITTEXT or RICHEDITTEXT object. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. An EDITTEXT or RICHEDITTEXT object that is accessed.

return

Optional. A Numeric Variable that indicates the character index.

line

Required. A decimal number or Numeric Variable that specifies the one-based line number.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. If the value returned is zero, the ZERO condition flag is set.

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

3. The returned value is the one-based index of the character from the beginning of the EDITTEXT object.

4. A {line} value of zero specifies the current line number (the line that contains the caret).

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

See Also: Method Syntax, EDITTEXT Methods, RICHEDITTEXT Methods