Displays a prompt in a dialog box, waits for the user to input text or click a button, and returns the contents of the text box.
string = InputBox(prompt[, title][, default][, x][, y][, helpfile, context])
prompt, title, default | : sexp |
x, y, context | : iexp |
helpfile | : path to .hlp help file |
prompt: String expression displayed as the message in the dialog box. The maximum length of prompt is approximately 1024 characters, depending on the width of the characters used. If prompt consists of more than one line, you can separate the lines using a carriage return character (Chr(13)), a linefeed character (Chr(10)), or carriage return-linefeed character combination (Chr(13) & Chr(10)) between each line.
title: String expression displayed in the title bar of the dialog box. If you omit title, the application name (App.Name) is placed in the title bar.
default: String expression displayed in the text box as the default response if no other input is provided. If you omit default, the text box is displayed empty.
x: Numeric expression that specifies, in twips, the horizontal distance of the left edge of the dialog box from the left edge of the screen. If x is omitted, the dialog box is horizontally centered.
y: Numeric expression that specifies, in twips, the vertical distance of the upper edge of the dialog box from the top of the screen. If y is omitted, the dialog box is vertically positioned approximately one-third of the way down the screen.
helpfile: String expression that identifies the Help file to use to provide context-sensitive Help for the dialog box. If helpfile is provided, context must also be provided.
context: Numeric expression that identifies the Help context number assigned by the Help author to the appropriate Help topic. If context is provided, helpfile must also be provided.
When both helpfile and context are supplied, a Help button is automatically added to the dialog box. NOTE The help button on an InputBox will attempt to open WinHlp32.exe (used for .hlp files); it will not work with HTMLHelp files. Unfortunately, as InputBox is an internally created Dialog box rather than a Windows API, the only workaround is to create a custom Dialog Box and direct the call to the help file in a similar manner as shown in this example.
If the user clicks OK or presses ENTER, the InputBox function returns whatever is in the text box. If the user clicks Cancel, the function returns a zero-length string ("").
OpenW 1
Local x%, value$
value$ = InputBox("Hallo", "Title", "Mr.")
Print value$
In contrast to VB the coordinates will be corrected automatically by GFA-BASIC 32, so that the InputBox remains on the screen.
Input Boxes are useful inside LG32 Libraries as, unlike OCX objects, their events can be handled internally.
InputBox uses Me as a parent and is displayed on Me’s (usually the curernt) monitor, except in GLLs, where Me is unavailable, when MsgBox0 should used instead.
{Created by Sjouke Hamstra; Last updated: 04/04/2018 by James Gaite}