Scripting API

<<GetNextObject

GetPrevObject>>

GetNumber

Script Name:		GetNumber
Name:		GetNumber
Library:		CmdExternal
Description:		Brings up a dialog box with a numeric edit control and prompts the user to enter a number. Returns the number along with an indication of whether OK or Cancel was pressed to end the dialog.
Status bar text:		Prompt the user to enter a number
Tool tip text:		Get Number

Parameter Repository:

Name	Script Name	Type	Description	Supports None	Default	Minimum	Maximum
Default Value	DefaultValue	Real	Default value to use. This will be the initial value in the dialog box.	No	1.0	-1000000.0	1000000.0
Dialog Title	DialogTitle	String	Text that is displayed in the title bar of the dialog box.	No
Get Integer Value	GetInteger	Enumeration (Boolean)	If true, the control is limited to integer input. If false, floating point values are allowed. Default is true	No	True
Use Logarithmic Slider	LogarithmicSlider	Enumeration (Boolean)	If true, the meter bar and popout slider on the numeric edit control will use logarithmic values. Default is false.	No	False
Maximum Value	MaxValue	Real	Maximum value that can be entered by the user	No	100.0	-1000000.0	1000000.0
Minimum Value	MinValue	Real	Minimum value of the number that can be entered	No	0.0	-1000000.0	1000000.0
Prompt	Prompt	String	Prompt string that is shown above the numeric edit control	No
General Settings	GeneralSettings	Parameter Repository	Contains parameters that control the execution of the command.	No

Return Type:

Name	Script Name	Type	Description	Supports None	Default	Minimum	Maximum
Result	Result	Parameter Repository	Return value of the command. Has a numeric value that is the result of the dialog box, along with an indication of whether OK or Cancel was pressed.	No

Command Attributes:
IsExternal:	true
NoRepeat:	true
NoDocumentNeeded:	true

Resource Attributes: