Difference between revisions of "AskMsgChoice"

(Initial spec for the function)
 
(categorization)
Line 1: Line 1:
 +
[[Category:User-interface functions]]
 +
 
''new to [[Analytica 4.4]]''
 
''new to [[Analytica 4.4]]''
  
Line 27: Line 29:
 
* [[AskMsgText]]
 
* [[AskMsgText]]
 
* [[Choice]]
 
* [[Choice]]
 +
* [[MsgBox]]

Revision as of 23:29, 17 August 2011


new to Analytica 4.4

AskMsgChoice(question,title,optionsList,default,showAll)

When evaluated, a pop-up dialog asks the user to select from a drop-down of possible choices.

Parameters:

  • «question» : Text that appears in the dialog body itself, above the choice pulldown.
  • «title» : The caption for the dialog.
  • «optionsList»: An unindex list, or a 1-D array, containing the possible options. It can be an expression that computes such a list. Numbers are coerced to text using the number format for the variable currently being evaluated.
  • «default» (optional): The item from the choice list that should be selected initially. Defaults to "All" when «showAll» is true, or to the first item otherwise. An error is issued when the value does not exist in «optionsList».
  • «showAll» : (optional, default: false): Indicates whether the "All" option should appear on the dropdown.

The result returned is the selected label from «optionsList», unless "All" is selected, in which case the result is the same value supplied as «optionsList».

The dialog includes an OK and a Cancel button. When Cancel is pressed, the current in-process computation is aborted.

When called from ADE, this function does not present any UI, and simply returns the default selection.

Examples

AskMsgChoice("What is your favorite color?", "Select color", ['Black','Blue','Brown','Cyan','Green','Orange','Red','White','Yellow'], 'Green')

See Also

Comments


You are not allowed to post comments.