BBjInputE::getMask

Description

Returns the mask of the BBjInputE control.

Syntax

Return Value

Method

string

getMask()

Parameters

None.

Return Value

Returns the mask of the BBjInputE control, which provides character-type verification.

Remarks

None.

Example

REM Get the mask 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 all
REM to upper caselimits input to 10 characters, and inserting the value "STANDARD"
REM when the user hits the restore key (normally ESCAPE)
myInputE! = myWindow!.addInputE(101,50,100,90,30,$0804$,"AAAAAAAAAA","",1,"STANDARD","BBjInputE")

REM Get the mask for the InputE control, this will return "AAAAAAAAA"
MASK$=myInputE!.getMask()

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

String Output Masking for mask options

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