BBjInputE::getRestore

Description

Returns the restore string of the BBjInputE control.

Syntax

Return Value

Method

string

getRestore()

Parameters

None.

Return Value

Returns a restore string.

Remarks

The restore string is the text that appears when the user hits the restore key (usually ESC) or by calling the BBjInputE::restore method.

Example

REM Get the restore value for an InputE control

REM Obtain the instance of the BBjAPI object
LET myAPI!=BBjAPI()

REM Open the SysGui device
SYSGUI=UNT
OPEN (SYSGUI) "X0"

REM Obtain the instance of the BBjSysGui object
LET mySysGui!=myAPI!.getSysGui()

REM Set addWindow param values
X=10
Y=10
WIDTH=200
HEIGHT=200
TITLE$="BBj Window"

REM Set the current context
mySysGui!.setContext(0)

REM Create a window
myWindow! = mySysGui!.addWindow(X,Y,WIDTH,HEIGHT,TITLE$)

REM Add an INPUTE control that accepts only alphabetic characters and converts
REM all to upper case, limiting input to 10 characters
myInputE! = myWindow!.addInputE(101,50,100,90,30,$0804$,"AAAAAAAAAA","",1,"STANDARD","")

REM Get the restore value for an InputE control, this will return "STANDARD"
RESTORE$=myInputE!.getRestore()

REM Register the CALLBACK routines
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())

REM Process Events
PROCESS_EVENTS

REM Callback routine called when the user closes the application window
APP_CLOSE:
RELEASE
RETURN

See Also

BBjAPI

BBjSysGui

BBjControl

BBjWindow

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.