INPUTBOX$: Difference between revisions

From QB64 Phoenix Edition Wiki
Jump to navigation Jump to search
(Add more examples and improved optional parameter behavior documentation)
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:_INPUTBOX$}}
{{DISPLAYTITLE:_INPUTBOX$}}
The '''_INPUTBOX$''' function displays a prompt in a dialog box, waits for the user to input text or click a button, and returns a string containing the contents of the text box. The returned string is an empty string ('''""''') if the user cancelled.
The '''_INPUTBOX$''' function displays a prompt in a dialog box, waits for the user to input text or click a button, and returns a string containing the contents of the text box.




{{PageSyntax}}
{{PageSyntax}}
:{{Parameter|result$}} = [[_INPUTBOX$]]([{{Parameter|title$}}][, {{Parameter|message$}}][, {{Parameter|defaultInput$}}])
: {{Parameter|result$}} = [[_INPUTBOX$]]([{{Parameter|title$}}][, {{Parameter|message$}}][, {{Parameter|defaultInput$}}])




{{PageParameters}}
{{PageParameters}}
* {{Parameter|title$}} is an optional dialog box title
* {{Parameter|title$}} is an optional dialog box title.
* {{Parameter|message$}} is an optional message or prompt that will is displayed in the dialog box
* {{Parameter|message$}} is an optional message or prompt that will is displayed in the dialog box.
* {{Parameter|defaultInput$}} is an optional string that is displayed in the text box as the default response if no other input is provided
* {{Parameter|defaultInput$}} is an optional string that is displayed in the text box as the default response if no other input is provided.




{{PageDescription}}
{{PageDescription}}
* All parameters are optional
* Use {{Parameter|message$}} to specify instructions to the user.
* Use {{Parameter|message$}} to specify instructions to the user
* All parameters are optional, hence omitting {{Parameter|defaultInput$}} will display a empty text box
* If {{Parameter|defaultInput$}} is an empty string ('''""'''), then a password box is shown, and the input is masked
** However, if {{Parameter|defaultInput$}} is provided, but is an empty string ('''""'''), then a password box is shown, and the text input will be masked.
* The dialog box automatically becomes a modal window if the application window is visible
* The dialog box automatically becomes a modal window if the application window is visible.
* The {{Parameter|result$}} may be an empty string ('''""''') if the user simply cancelled the dialog.





Revision as of 13:43, 1 December 2023

The _INPUTBOX$ function displays a prompt in a dialog box, waits for the user to input text or click a button, and returns a string containing the contents of the text box.


Syntax

result$ = _INPUTBOX$([title$][, message$][, defaultInput$])


Parameters

  • title$ is an optional dialog box title.
  • message$ is an optional message or prompt that will is displayed in the dialog box.
  • defaultInput$ is an optional string that is displayed in the text box as the default response if no other input is provided.


Description

  • Use message$ to specify instructions to the user.
  • All parameters are optional, hence omitting defaultInput$ will display a empty text box
    • However, if defaultInput$ is provided, but is an empty string (""), then a password box is shown, and the text input will be masked.
  • The dialog box automatically becomes a modal window if the application window is visible.
  • The result$ may be an empty string ("") if the user simply cancelled the dialog.


Availability

  • QB64-PE v3.4.0 and up


Examples

Example 1
Hello, world with common dialogs
username$ = _INPUTBOX$("Hello App", "Enter your name:", "anonymous")

_MESSAGEBOX "Hello App", "Hello " + username$, "info"
Example 2
Checking if the user cancelled the input
age$ = _TRIM$(_INPUTBOX$(, "Enter your age:"))

IF LEN(age$) = 0 THEN
    _MESSAGEBOX , "Cancelled."
ELSE
    _MESSAGEBOX , "Age = " + age$
END IF
Example 3
Getting passwords
password$ = _INPUTBOX$("Login", "Enter password:", "")

IF LEN(password$) = 0 THEN
    _MESSAGEBOX , "Cancelled."
ELSE
    _MESSAGEBOX , "You entered = " + password$
END IF


See also



Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link