Field-Map Scripting

4.1.1.2.5 InputText

InputText function


Prototype:

function InputText (const caption, msg :string; const text :variant) :variant

Description:

The InputText function displays a dialog allowing the user to input a text. The dialog has a caption specified by the caption parameter, contains the text specified by the msg parameter and "OK" and "Cancel" buttons.

Syntax:

variable := InputText(Caption,Msg,Text);


Part

Description


variable

variable declared as variant


Caption

A string parameter which specifies the caption of the dialog box.


Msg

A string parameter which specifies the message displayed in the dialog box.


Text

A text which appears in a dialog window.




Return value:

A string variable (or default text parameter) if the user has entered a valid string and confirmed it by the "OK" button or a null variant if the user has pressed the "Cancel" button



Example:


Var myText : variant;

Begin
  myText := InputText('Memo', 'Enter your memo:', 'Some text...');
End.



See also:

InputInteger; InputIntegerWithCounter; InputFloat; InputString; InputText; InputOption; InputOptionWithStartingValue; InputFromList;InputFromListWithStartingValue; InputFromCheckListTab; InputFromListTab