BBjWindow::addStaticText

Description

Adds a static text control to the BBjWindow.

Syntax

Return Value

Method

BBjStaticText

addStaticText(int ID, number x, number y, number w, number h, string title)

BBjStaticText

addStaticText(int ID, number x, number y, number w, number h, string title, string flags)

BBjStaticText

addStaticText(int ID, string title)

BBjStaticText

addStaticText(int ID, string title, string flags)

BBjStaticText

addStaticText(string title)

BBjStaticText

addStaticText(string title, string flags)

Parameters

Variable

Description

ID

Control ID number. It must be an integer between 1 and 32767 and be unique within a given top-level window.

x

Horizontal position of the upper-left corner of the control in current units.

y

Vertical position of the upper-left corner of the control in current units.

width

Width of the control in current units.

height

Height of the control in current units.

title

Title of the control. Including the '&' before a character in the title causes it to be an accelerator.

flags

Control flags, as follows:

Flag Description
$0001$ Sets the control to be initially disabled.
$0010$ Sets the control to be initially invisible.
$0800$ Draws a recessed client edge around the control.
$1000$ Draws a raised edge around the control.
$2000$ Left justifies static text.
$4000$ Centers static text.
$8000$ Right justifies static text.
$10000$ Prevents static text control text from wrapping.

Return Value

Returns the created BBjStaticText object.

Remarks

By default, only the initial value of a static text control determines the hotkey, as described under "Hot Keys." When the UPDATE_TEXT_HOTKEYS !OPTIONS setting is set to TRUE, the hotkey is updated whenever the text is changed.

If the ID parameter is not specified, a control ID is assigned dynamically using getAvailableControlID().

If the x, y, width, and height parameters are not specified, they are all initialized to 0. This is typically for use with DWC windows that dynamically arrange their contents (window creation flag $00100000$).

Example

rem 'Add a static text control to a window

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 a static text control on the window
myStaticText! = myWindow!.addStaticText(101,50,100,90,30,"Static Text",$0000$)

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

'TEXT' Mnemonic - Create a Static Text Control

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