CTRL() Function

BBj-Specific Information

For this topic's original documentation, see the CTRL() Function.

Parameter

Description

function

If not specified, the default is set according to the type of object in question. The following types behave as though function=2 (Get value) was requested: radio buttons, check boxes, list boxes, list buttons, scroll bars, menu items, tool buttons, INPUTN and INPUTD. All others behave as though function=1 (Get text) was requested.

CTRL() Function 2 – Get Value (BBj 3.02 and higher)

This CTRL() function returns a value, according to the following:

Resource

Item Returned

INPUTD control

A 4-byte signed binary integer representing the Julian date of the control. If the text in the control is blank or does not correspond to a valid date, this returns a value of -1 ($FFFFFFFF$).

 

CTRL() Function 4 – Get Type

This CTRL() function returns the object type as two binary bytes. The first byte is the class of the object, and the second byte is the type of the object.

BBj reports the class of a CEDIT control as generic (first byte = 1) rather than customEdit (first byte = 2). The second byte of CTRL() 4 will still be 22 (custom edit control).

BBj supports additional values for the second byte as follows:

Second Byte Decimal Value

Type of Object

24

Line Chart

25

Bar Chart

26

Pie Chart

27

HTML View

28

MenuButton control

29

PrintPreview control

108

Image control

109

Tree control

112

ProgressBar control

113

Navigator control

114

INPUTD control

117

Horizontal slider control

118

Vertical slider control

119

FileChooser

120

ColorChooser

121

FontChooser

122

DataboundGrid control

123

INPUTDSpinner control

124

INPUTESpinner control

125

INPUTNSpinner control

126

EditBoxSpinner control

CTRL() Function 14 – Get Printer Setup

Not supported in BBj.

CTRL() Function 16 – Retrieve Foreground Color

In Windows, this function returns the current window TEXTCOLOR. In Visual PRO/5, it always returns the system default window text color. To retrieve that value in BBj, use:

SENDMSG(sysgui,-1,1,0,$19$)

CTRL() Function 17 – Get Child Window Context ID

This CTRL() function returns the context ID of a child window within the given context.

Function

Description

17

Returns the context of a child window as a binary string. Convert to a number as in the following:

context=dec(ctrl(sysgui,child_control_id,17,parent_context))

See Also

Functions - Alphabetical Listing



______________________________________________________________________________________

Copyright BASIS International Ltd. BBj®, Visual PRO/5®, PRO/5®, and BBx® are registered trademarks.