InputBox - Revision history

MLipok: /* Syntax */

2017-11-04T09:19:21Z

Syntax

← Older revision		Revision as of 09:19, 4 November 2017
Line 4:		Line 4:
	=Syntax=		=Syntax=
	<syntaxhighlight lang="autoit">		<syntaxhighlight lang="autoit">
	~~Local $str =~~ InputBox("title","prompt"[,"default"[,"password char[Option]"[,width[,height[,left,top[,timeout[,hwnd]]]]]])		InputBox("title","prompt"[,"default"[,"password char[Option]"[,width[,height[,left,top[,timeout[,hwnd]]]]]])
	</syntaxhighlight>		</syntaxhighlight>

MLipok: /* Syntax */

2017-11-04T09:19:08Z

Syntax

← Older revision		Revision as of 09:19, 4 November 2017
Line 3:		Line 3:

	=Syntax=		=Syntax=
	$str = InputBox("title","prompt"[,"default"[,"password char[Option]"[,width[,height[,left,top[,timeout[,hwnd]]]]]])		<syntaxhighlight lang="autoit">
			Local $str = InputBox("title","prompt"[,"default"[,"password char[Option]"[,width[,height[,left,top[,timeout[,hwnd]]]]]])
			</syntaxhighlight>

	=Parameters=		=Parameters=

MLipok: /* Title, Prompt, & Default */

2017-11-04T09:18:52Z

Title, Prompt, & Default

← Older revision		Revision as of 09:18, 4 November 2017
Line 22:		Line 22:
	The title, prompt, and default fields set the title of the box, the user prompt, and the initial value of the user input field respectively.		The title, prompt, and default fields set the title of the box, the user prompt, and the initial value of the user input field respectively.

	$str = InputBox("Login","Enter your name:","John Generic")		<syntaxhighlight lang="autoit">
			Local $str = InputBox("Login","Enter your name:","John Generic")
			</syntaxhighlight>

	=Password Character=		=Password Character=

MLipok: /* Password Character */

2017-11-04T09:18:33Z

Password Character

← Older revision		Revision as of 09:18, 4 November 2017
Line 31:		Line 31:

	; Require input no larger than 5 characters in length, replace input with "*"		; Require input no larger than 5 characters in length, replace input with "*"
	$str = InputBox("Password Check","Please enter your password:","noobs","*M5")		<syntaxhighlight lang="autoit">
			Local $str = InputBox("Password Check","Please enter your password:","noobs","*M5")
			</syntaxhighlight>

	=Width & Height=		=Width & Height=

MLipok: /* Width & Height */

2017-11-04T09:18:17Z

Width & Height

← Older revision		Revision as of 09:18, 4 November 2017
Line 36:		Line 36:
	As mentioned above, width and height must be defined together. The size is determined by pixels with a minimum size of 190x115 and a default size of 250x190 however the box is resizable by the user.		As mentioned above, width and height must be defined together. The size is determined by pixels with a minimum size of 190x115 and a default size of 250x190 however the box is resizable by the user.

	$str = InputBox("Size Counts","Resize me!","","",190,115)		<syntaxhighlight lang="autoit">
			Local $str = InputBox("Size Counts","Resize me!","","",190,115)
			</syntaxhighlight>

	=Left & Top=		=Left & Top=

MLipok: /* Return Values */

2017-11-04T09:17:59Z

Return Values

← Older revision		Revision as of 09:17, 4 November 2017
Line 64:		Line 64:
	</table>		</table>

	$str = InputBox("Try It","Do Something!","stuff","",10)		<syntaxhighlight lang="autoit">
	MsgBox(0,"Bada Bing",@error & " " & $str)		Local $str = InputBox("Try It","Do Something!","stuff","",10)
			MsgBox(0,"Bada Bing",@error & " " & $str)
			</syntaxhighlight>
	[[Category:GUI]]		[[Category:GUI]]

MLipok: /* Timeout */

2017-11-04T09:17:41Z

Timeout

← Older revision		Revision as of 09:17, 4 November 2017
Line 47:		Line 47:
	=Timeout=		=Timeout=
	The timeout parameter acts to close the InputBox after ''x'' number of seconds have passed.		The timeout parameter acts to close the InputBox after ''x'' number of seconds have passed.
			<syntaxhighlight lang="autoit">
	$str = InputBox("Type Fast","What's 6 x 7?","","",-1,-1,Default,Default,3) ; box will close in 3 seconds		Local $str = InputBox("Type Fast","What's 6 x 7?","","",-1,-1,Default,Default,3) ; box will close in 3 seconds
			</syntaxhighlight>
	If the InputBox times out before a choice is made a 2 is returned.		If the InputBox times out before a choice is made a 2 is returned.

MLipok: /* Left & Top */

2017-11-04T09:17:25Z

Left & Top

← Older revision		Revision as of 09:17, 4 November 2017
Line 41:		Line 41:
	Like width and height, left and top must be defined together. The position of the box is measured in pixels from the leftmost position on the screen to the topmost. Thus the upper left hand corner of your screen would be at coordinates (0,0). By default the input box is centered but is also movable by the user.		Like width and height, left and top must be defined together. The position of the box is measured in pixels from the leftmost position on the screen to the topmost. Thus the upper left hand corner of your screen would be at coordinates (0,0). By default the input box is centered but is also movable by the user.

	$str = InputBox("Move Me","Move me!","","",-1,-1,0,0) ; top left corner of the screen		<syntaxhighlight lang="autoit">
			Local $str = InputBox("Move Me","Move me!","","",-1,-1,0,0) ; top left corner of the screen
			</syntaxhighlight>

	=Timeout=		=Timeout=

Jaberwocky6669: Category:GUI

2013-08-01T03:27:54Z

Category:GUI

← Older revision		Revision as of 03:27, 1 August 2013
Line 64:		Line 64:
	$str = InputBox("Try It","Do Something!","stuff","",10)		$str = InputBox("Try It","Do Something!","stuff","",10)
	MsgBox(0,"Bada Bing",@error & " " & $str)		MsgBox(0,"Bada Bing",@error & " " & $str)

			[[Category:GUI]]

12.25.75.70 at 20:47, 23 May 2008

2008-05-23T20:47:07Z

New page

InputBox displays a popup box prompting the user to enter a string.
Adapted from [http://www.autoitscript.com/autoit3/docs/functions/InputBox.htm AutoIt doc].

=Syntax=
$str = InputBox("title","prompt"[,"default"[,"password char[Option]"[,width[,height[,left,top[,timeout[,hwnd]]]]]])

=Parameters=
<table border="1"><tr><td>'''Param'''</td><td>'''Purpose'''</td></tr>
<tr><td>title</td><td>Sets the title of the input box</td></tr>
<tr><td>prompt</td><td>Sets the prompt to the user</td></tr>
<tr><td>default</td><td>Sets user input field to default text</td></tr>
<tr><td>password char</td><td>Set the character value to replace input.(Optional)</td></tr>
<tr><td>width</td><td>Set the width of the window in pixels. Height must also be set. Default value -1 or "Default".(Optional)</td></tr>
<tr><td>height</td><td>Set the height of the window in pixels. Width must also be set. Default value -1 or "Default".(Optional)</td></tr>
<tr><td>left</td><td>Set the distance of the window from the left side of the screen in pixels. Top must also be set. Default value -1 or "Default".(Optional)</td></tr>
<tr><td>top</td><td>Set the distance of the window from the top of the screen in pixels. Left must also be set. Default value -1 or "Default".(Optional)</td></tr>
<tr><td>timeout</td><td>Set the number of seconds till close.(Optional)</td></tr>
<tr><td>hwnd</td><td>Set the window handle as the parent.(Optional)</td></tr>
</table>

=Title, Prompt, & Default=
The title, prompt, and default fields set the title of the box, the user prompt, and the initial value of the user input field respectively.

$str = InputBox("Login","Enter your name:","John Generic")

=Password Character=
The password char parameter replaces all inputed characters with the first value. Placing a whitespace in the first character position will cause input to be shown as normal. Subsequent characters are used to restrict and enforce input.
*Options
**M = Mandatory entry before continuing
**''n'' = Only ''n'' characters may be entered where ''n'' is an integer

; Require input no larger than 5 characters in length, replace input with "*"
$str = InputBox("Password Check","Please enter your password:","noobs","*M5")

=Width & Height=
As mentioned above, width and height must be defined together. The size is determined by pixels with a minimum size of 190x115 and a default size of 250x190 however the box is resizable by the user.

$str = InputBox("Size Counts","Resize me!","","",190,115)

=Left & Top=
Like width and height, left and top must be defined together. The position of the box is measured in pixels from the leftmost position on the screen to the topmost. Thus the upper left hand corner of your screen would be at coordinates (0,0). By default the input box is centered but is also movable by the user.

$str = InputBox("Move Me","Move me!","","",-1,-1,0,0) ; top left corner of the screen

=Timeout=
The timeout parameter acts to close the InputBox after ''x'' number of seconds have passed.

$str = InputBox("Type Fast","What's 6 x 7?","","",-1,-1,Default,Default,3) ; box will close in 3 seconds

If the InputBox times out before a choice is made a 2 is returned.

=Return Values=
Success: Returns input string and sets @Error

Failure: Returns empty string and sets @Error

<table border="1"><tr><td>Error Code</td><td>Reason</td></tr>
<tr><td>0</td><td>Successful execution</td></tr>
<tr><td>1</td><td>Cancel button pressed</td></tr>
<tr><td>2</td><td>Timeout occurred</td></tr>
<tr><td>3</td><td>InputBox failed to open properly</td></tr>
</table>

$str = InputBox("Try It","Do Something!","stuff","",10)
MsgBox(0,"Bada Bing",@error & " " & $str)