AskMsgNumber(question,text,default, checkboxText, initialCheck)


AskMsgNumber(question : Text; title : optional text; default : optional numeric ; checkboxText : optional text ; initialCheck : optional boolean)

A Dialog Function that creates a dialog box with the specified title, question and a textbox containing the default value, if any. It returns the number entered by the user into the text box.

If the default is specified, it is displayed using the number format for the object containing the call. When not specified, the entry box will be blank initially. By setting the number format for the variable containing the call to date, a date entry is accepted.

The OK button is active only when a valid number has been entered. The Cancel button aborts the current computation.

The message box appears only when this function is evaluated. Since Analytica caches results once they are computed, if you embed this in a variable, you will not see the question every time you view the result. To trigger the question again, you must change something upstream that the variable depends on, so the result is invalidated. If you place it inside a button script, you would see it every time the button is pressed.

(New to Analytica 5.4) You can optionally include a checkbox question at the bottom by specifying «checkboxText». Specify whether it is checked initially by setting «initialCheck» to True or False. When «initialCheck» is unspecified, it defaults to off (False). When you specify «checkboxText», it returns two return values, where the second return value is the boolean state of the checkbox. To capture this, use for example

Local (enteredText, checked) := AskMsgText("Enter the plant name", checkboxText:"Is a co-generation facility");


AskMsgNumber("Please enter an approximate estimate of the internal rate of return", default: 15%)

From ADE

When evaluated in the Analytica Decision Engine (ADE), it calls IAdeUICallbacks::AskMsgNumber(...). From within that callback, the parent application can display a dialog, collect input from the end-user, and return that as the return value. To receive the callback, the parent application must have previously registered the callback with ADE using CAEngine::SetCallbackObject( ). If it has not registered a callback, then «default» is returned.

See Also


You are not allowed to post comments.