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

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.