Cicode Programming Reference > Cicode Function Categories > Form Functions > FormPrompt

FormPrompt

Adds a prompt field to the current form. You should call this function only after the FormNew() function and before the FormRead() function.

Syntax

FormPrompt(Col, Row, Prompt [,Width] [,Height])

Col:

The number of the column in which the prompt will be placed. Enter a number from 0 (column 1) to the form width - 1. For example, to place the prompt in column 8, enter 7.

Row:

The number of the row in which the prompt will be placed. Enter a number from 0 (row 1) to the form height - 1. For example, to place the prompt in row 6, enter 5.

Prompt:

The prompt string.

Width:

The width of the area that the prompt string will wrap within (measured using average character width). For this setting to be applied, you also need to specify a value for Height.

Height:

The height of the area that the prompt string will display within (measured using average character height). For this setting to be applied, you also need to specify a value for Width.

Return Value

The field handle if it is added successfully, otherwise -1 is returned.

Related Functions

FormNew, FormRead

Example

FormPrompt(1,2,"Enter Recipe");

See Also

Form Functions

Published June 2018