BBjInputD::getLength

Description

In BBj 4.0 and higher, this method returns the maximum input length for the BBjInputD control.

Syntax

Return Value

Method

int

getLength()

Parameters

None.

Return Value

Returns the maximum input length of the BBjInputD control.

Remarks

The maximum input length is initially set to the length of a date formatted with the current mask. For example, a mask of "%Mz/%Dz/%Yz" implies a maximum length of 8. This initial default value can be overridden with BBjInputD::setLength().

Example

rem 'Get the maximum input length for an InputD 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$,$00010002$)

rem 'Add an InputD control that uses a US-style date mask, inserting
rem 'today's date when the user hits the restore key (normally ESCAPE)
myInputD! = myWindow!.addInputD(101,50,100,90,30,$080c$,"%Mz/%Dz/%Yz",$$,0,0)

rem 'Retrieve the default length; this will print 8 (MM/DD/YY)
print "Default length for ",myInputD!.getMask()," is",myInputD!.getLength()

rem 'Reset the maximum length to allow for user to type MM/DD/YYYY
myInputD!.setLength(10)

rem 'Retrieve the default length; this will print 8 (MM/DD/YY)
print "Maximum length increased to",myInputD!.getLength()

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

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