Difference between revisions of "User confirm"
Jump to navigation
Jump to search
imported>Icon315 |
imported>Roippi (update for user_confirm() overloaded signature) |
||
| Line 12: | Line 12: | ||
return_also={{#var:return_also}}| | return_also={{#var:return_also}}| | ||
parameter1={{Param|string|message}}| | parameter1={{Param|string|message}}| | ||
| + | }}| | ||
| + | |||
| + | function2={{Function| | ||
| + | name={{#var:name}}| | ||
| + | aggregate={{#var:aggregate}}| | ||
| + | return_type={{#var:return_type}}| | ||
| + | return_also={{#var:return_also}}| | ||
| + | parameter1={{Param|string|message}}| | ||
| + | parameter2={{Param|int|timeOutMillis}}| | ||
| + | parameter3={{Param|boolean|defaultValue}}| | ||
p1desc={{pspan|message}} is the text to display in the confirmation pop-up| | p1desc={{pspan|message}} is the text to display in the confirmation pop-up| | ||
| + | p2desc={{pspan|timeOutMillis}} the length of time to display the dialog, in milliseconds| | ||
| + | p3desc={{pspan|message}} the value to return if the user does not choose an input before <b>timeOutMillis</b> ms| | ||
}}| | }}| | ||
function_description=Presents the user with a pop-up dialog box with the text in {{pspan|message}} (can use escaped characters, such as "<nowiki>\n</nowiki>" for a newline); returns true if the user selects "Yes" and false if the user selects "No."</p> | function_description=Presents the user with a pop-up dialog box with the text in {{pspan|message}} (can use escaped characters, such as "<nowiki>\n</nowiki>" for a newline); returns true if the user selects "Yes" and false if the user selects "No."</p> | ||
| + | <p>If you wish for the dialog to "time out" and return a default value if the user does not select an option, use the three-parameter version.</p> | ||
<p>Please use these sparingly, as it can defeat the purpose of scripting if the user must constantly provide information during execution.| | <p>Please use these sparingly, as it can defeat the purpose of scripting if the user must constantly provide information during execution.| | ||
Revision as of 17:12, 12 July 2012
Function Syntax
boolean user_confirm(string message )
boolean user_confirm(string message ,int timeOutMillis ,boolean defaultValue )
- message is the text to display in the confirmation pop-up
- timeOutMillis the length of time to display the dialog, in milliseconds
- message the value to return if the user does not choose an input before timeOutMillis ms
Presents the user with a pop-up dialog box with the text in message (can use escaped characters, such as "\n" for a newline); returns true if the user selects "Yes" and false if the user selects "No."
If you wish for the dialog to "time out" and return a default value if the user does not select an option, use the three-parameter version.
Please use these sparingly, as it can defeat the purpose of scripting if the user must constantly provide information during execution.
Code Sample
A check to see if the user truly wants to execute a script.
if (!user_confirm("Are you sure you want to proceed with executing this script?") )
{
abort("Script execution canceled by user.");
}