FormAdd()

Add a control to the dialog window created with FormCreate().

Syntax

FormAdd([<cLabel>], [<xInitial>], [<xParam>], [<cMessage>]) --> lSuccess

Arguments

<cLabel> --> The text message prompt to appear in front of the control.

<xInitial> --> The initial value to assign the control.

<xParam> --> Is a parameter related to the value assigned to the form control.

<cMessage> --> An optional status bar message used to explain the purpose of the input.

Returns

Returns TRUE if the control was successfully added to the form dialog window, otherwise FALSE indicates failure.

To query the contents of the various controls on the form after input is finished see the function FormResult().

Description

This function is used to add a controls to a form dialog window before it is displayed. The type of control created is determined by xInitial's value.

Character String Input

<xInitial> --> This is the initial value to assign the edit control that will be created.

<xParam> --> You may either pass the length (size) of the control or a suitable picture format.

If the length (size) is longer than the contents of xInitial, then the edit control will be extended to that size, otherwise if it is smaller, the edit control length will correspond to the supplied size, and automatic horizontal scrolling will be activated.

<cMessage> --> an optional message to appear on the status bar.

Date Input

<xInital> --> Pass the date value. For example, Today() or CTOD("12/06/02") or CTOD("").

<xParam> --> do not pass any parameter here for dates.

<cMessage> --> an optional message to appear on the status bar.

Checkboxes (Yes/No Questions) Input

<xInital> --> TRUE or FALSE. This is the initial value of the checkbox. TRUE = ticked and FALSE = unticked.

<xParam> --> TRUE or FALSE. The value of TRUE left justifies the checkbox/question. A value of FALSE right justifies the checkbox.

Edit Box Input

<xInitial> --> the initial character string value or a blank string ("").

<xParam> --> a two dimensional array which specifies the width and height in characters. For example, { 20, 4 }

Combobox (List of Choices) Input

<xInitial> --> The initial selection from the available list of choices as a character string. For example, "Male". If not specified, item 1 from the list of choices will be selected by default.

<xParam> --> The list of available choices as an array of character strings. For example, { "Male", "Female" }

To display a combobox <xInitial> must be passed as a character string. This string should match one of the entries of the parameter list.

Radiobutton input

<xInitial> --> The number of the selected radiobutton.

<xParam> --> An array of character strings that represents the different choices. For example, { "Cat", "Dog", "Mouse", "Fish" }

Only one set of radiobuttons may be specified per form window.

To display a radiobutton <xInitial> must be specified as a number.

Separator

To add a gap between controls call FormAdd() without parameters.

Text Label

To add a text label in a bold font, specify a <cLabel> but do not specify an <xInitial>

Passwords

Assign xParam the value "*" to prompt for a password. Input as it is typed is not echoed to the screen. Asterisk (*) characters are displayed instead.

Example #1

FormCreate()

* Create an edit control with the label 'Name'

* assign it a blank initial value and make it 20

* characters wide

FormAdd("Name", "", 20, "Please enter your name.")

* Create an edit control with the label 'Number'

* and assign it the value "123" and only allow

* numbers to be entered

FormAdd("Number", "123 ", "99999999")

* Prompt for today's date

FormAdd("Today's Date", Today())

* Display an edit box

FormAdd("Notes", "", { 30, 4 })

* Present a list of choices

FormAdd("Sex", "Male", { "Male", "Female" } )

* Present a list of radiobuttons and mark the first (1)

* entry "Cat" as selected.

FormAdd("Animal", 1, { "Cat", "Dog", "Mouse", "Fish" } )

FormShow("Example Form Window")

Example #2

* Prompt for normal input and password input

Declare cPass Type String

Declare cName Type String

cPass := " "

cName := " "

FormCreate()

FormAdd("Name", cName)

FormAdd("Password", cPass, "*")

FormShow("Log in")

cPass := FormResult(2)

Echo(cPass)

Example #3

* Show 'Account Process' in bold and then

* prompt 'For Your Name'

FormCreate()

FormAdd("Account Process")

FormAdd()

FormAdd("Enter Your Name", SPACE(20))

FormShow("Example #3")

For more information on picture formats see the topic: Variables & Data Types.

____________________________

Related Topics

Business Function List

FormCreate()

FormResult()

FormShow()