GetPriorStatic Function

Class

Control.

Action

Returns the static-text label associated with the control.

Syntax

sLabel = control.GetPriorStatic ([bRawMode])

Variable	Description
`sLabel`	The label associated with the control. STRING.
`bRawMode`	Optional: `TRUE` to leave platform-specific information in the strings, or `FALSE` (default) to remove that information. BOOLEAN. The Open Agent always uses FALSE for this value regardless of what is specified in the script. The returned strings include trailing and leading spaces but ellipses, accelerators, and hot keys are removed.

Variable

Description

sLabel

The label associated with the control. STRING.

bRawMode

Optional: TRUE to leave platform-specific information in the strings, or FALSE (default) to remove that information. BOOLEAN.

The Open Agent always uses FALSE for this value regardless of what is specified in the script. The returned strings include trailing and leading spaces but ellipses, accelerators, and hot keys are removed.

Notes

GetPriorStatic looks for the closest static text above or to the left of the control. If it cannot associate any static text with the control, GetPriorStatic returns an empty string ("").

When bRawMode is TRUE, the returned string includes trailing and leading spaces, ellipses, accelerators, and hot keys. These additional characters make the string platform-specific. When bRawMode is FALSE, the output of GetPriorStatic does not include any special characters.

Example

STRING sLabel
sLabel = GotoLine.LineNumber.GetPriorStatic()