Function: prompt

String prompt( String strMessage, String strDefault )

Summary

Get simple input from the user.

Parameters

Parameter	Description
String strMessage	The message you want the user to see. This can be simple HTML and can be multi-line
String strDefault	The default value if the user simply clicks OK.

Returns

Returns the value the user entered, or strDefault if the user just clicked OK, or null if the user clicked cancel.

Examples

Below is a simple script that shows how to add a new command, bind it to a keyboard shortuct and then when the command is executed prompt the user for some input.

function onPromptUpdate( up )
{
	up.enable( true );
}
function onPrompt( up )
{
	var n = prompt( "<b>Please enter a thing</b><br><i>Of course</i> by 'thing' I mean something useful and not something <font color='red'>useless</font>.", "default" );
	if( n != null )
	{
		alert( "You entered: " + n );
	}
	else
	{
		alert( "You hit cancel" );
	}
}

app.addNewCommand( "Prompt", onPrompt, onPromptUpdate );
app.addKeyboardShortcut( "Prompt", "Ctrl+Shift+Q" );

Requirements

1109