AIMMS Function Reference - Dialog Functions
This file contains only one chapter of the book. For a free download of thecomplete book in pdf format, please visit
Aimms supports the following functions for simple interaction with the enduser.
The procedure DialogAsk displays a small dialog box containing a message andtwo or three buttons. Usually these buttons are an OK and Cancel, or Yes, Noand Cancel, but they can contain any text you want. The procedure returnsthe number of the button that is pressed by the user.
A scalar string expression containing the text you want to display inthe dialog box.
A scalar string expression containing the text of the first button.
A scalar string expression containing the text of the second button.
A scalar string expression containing the text of the third button. Ifthis argument is omitted then the dialog box will only show two but-tons.
A scalar string expression containing the text that you want to appearin the title of the dialog box.
The procedure returns the number of the button that is pressed: 1 for thefirst button, 2 for the second button or 3 for the third button.
If the user presses the Esc key, or closes the dialog box via the [x] in thetop right corner, then this is interpreted as pressing the last button in thedialog box (which is usually the Cancel button).
The procedure DialogError displays a small dialog box containing a specifiederror message and an OK button. The execution will be halted until the userpresses the OK button.
A scalar string expression containing the text you want to display inthe dialog box.
A scalar string expression containing the text that you want to appearin the title of the dialog box.
The procedures DialogMessage and DialogError only differ in the icon thatis displayed at the left side of the dialog box.
The procedure DialogGetColor displays a standard Windows color selection di-alog box. The procedure returns the color (RGB values) selected by the user.
! (input/output) scalar numerical parameter
! (input/output) scalar numerical parameter
! (input/output) scalar numerical parameter
A scalar numerical paramter containing the red value of the selectedcolor.
A scalar numerical paramter containing the green value of the selectedcolor.
A scalar numerical paramter containing the blue value of the selectedcolor.
The procedure returns 1 if the user completed the color selection dialogbox successfully, or 0 otherwise.
The procedure DialogGetDate displays a standard Windows date selection dia-log box. The procedure returns the date (in the specified format) selected bythe user.
A scalar string expression containing the text you want to display inthe title of the dialog box.
A scalar string expression containing the date format of the date argu-ment.
A scalar string parameter in which the selected date is returned ac-cording to the date format specified in format.
A scalar integer expression in the range 1
of rows to be displayed in the date selectiond dialog box.
A scalar integer expression in the range 1
of columns to be displayed in the date selectiond dialog box.
The procedure returns 1 if the user completed the date selection dialog boxsuccessfully, or 0 otherwise.
If the date argument contains a valid date according to the format specifiedin date-format, Aimms will set the initial date in the date selection dialogbox equal to the specified date.
The date format specification components are discussed in full detail inSection of the Language Reference.
The procedure DialogGetElementByData is an extension of the procedure Di-alogGetElementByText. Instead of only showing a list box with only a singlestring per element, this procedure allows you to show a list box with multi-ple columns of text per element. The text that is displayed in each columnis specified via a 2-dimensional string parameter. The first dimension of thisparameter corresponds to the rows of the list box, the second dimension cor-responds to the column in the listbox.
! (input/output) scalar element parameter
A scalar string expression containing the text you want to display astitle of the dialog box.
A scalar element parameter. When creating the dialog box, the rangeset of this parameter is used to fill the list with elements, and thecurrent value of the element parameter will be initially selected. Onreturn, this parameter will refer to the selected element.
A 2-dimensional string parameter. The first index in its domain shouldmatches the range set of the element parameter reference, the secondindex defines the number of columns that are shown. Instead of theelement names, the dialog box will display multiple columns of textderived from this parameter.
The procedure returns 1 if the user has pressed the OK button, and 0 if hehas pressed the Cancel button.
The procedure DialogGetElement displays a dialog box in which the user canselect an element from a list of set elements.
! (input/output) scalar element parameter
A scalar string expression containing the text you want to display astitle of the dialog box.
A scalar element parameter. When creating the dialog box, the rangeset of this parameter is used to fill the list with elements, and thecurrent value of the element parameter will be initially selected. Onreturn, this parameter will refer to the selected element.
The procedure returns 1 if the user has pressed the OK button, and 0 if hehas pressed the Cancel button.
The procedure DialogGetElementByText displays a dialog box in which the usercan select an element from a set. However, other than DialogGetElement, thisprocedure does not show a list of element names but a list of strings, whichare given as a separate argument to the procedure.
! (input/output) scalar element parameter
A scalar string expression containing the text you want to display astitle of the dialog box.
A scalar element parameter. When creating the dialog box, the rangeset of this parameter is used to fill the list with elements, and thecurrent value of the element parameter will be initially selected. Onreturn, this parameter will refer to the selected element.
A 1-dimensional string parameter, with a domain that matches therange set of the element parameter reference. Instead of the elementnames, the dialog box will display the corresponding strings of thisparameter.
The procedure returns 1 if the user has pressed the OK button, and 0 if hehas pressed the Cancel button.
The procedure DialogGetNumber displays a small dialog box in which the usercan enter a single numerical value. The dialog box remains on the screen (andthus halts the execution) until the user presses either the OK or the Cancelbutton.
! (input/output) scalar numerical identifier
A scalar string expression containing the text you want to display infront of the edit field.
A scalar identifier. When creating the dialog box, its value is used to fillthe edit field. After the user presses the OK button, the edited value isreturned through this argument.
A integer expression to indicate the number of decimals that is dis-played initially.
A scalar string expression containing the text that you want to appearin the title of the dialog box.
The procedure returns 1 if the user has pressed the OK button, and 0 if hehas pressed the Cancel button.
The procedure DialogGetPassword displays a small dialog box in which the usercan enter a password string. In the dialog box the string is presented by asequence of asterisks. The dialog box remains on the screen (and thus haltsthe execution) until the user presses either the OK or the Cancel button.
A scalar string expression containing the text you want to display infront of the edit field.
A scalar string valued identifier containing the password. When creat-ing the dialog box, its value is used to fill the edit field. After the userpresses the OK button, the edited password string is returned throughthis argument.
A scalar string expression containing the text that you want to appearin the title of the dialog box.
The procedure returns 1 if the user has pressed the OK button, and 0 if hehas pressed the Cancel button.
The procedure DialogGetString displays a small dialog in which the user canenter a text string. The dialog remains on the screen (and thus halts the exe-cution) until the user presses either the OK or the Cancel button.
A scalar string expression containing the text you want to display infront of the edit field.
A scalar string valued identifier. When creating the dialog, its value isused to fill the edit field. After the user presses the OK button, theedited string is returned through this argument.
A scalar string expression containing the text that you want to appearin the title of the dialog box.
The procedure returns 1 if the user has pressed the OK button, and 0 if hehas pressed the Cancel button.
The procedure DialogMessage displays a small dialog box containing a specifiedinformational message and an OK button. The execution will be halted untilthe user presses the OK button.
A scalar string expression containing the text you want to display inthe dialog box.
A scalar string expression containing the text that you want to appearin the title of the dialog box.
The procedures DialogMessage and DialogError only differ in the icon thatis displayed at the left side of the dialog box
The procedure DialogProgress displays a small dialog box containing a speci-fied message and a progress bar that can indicate how much of a specific taskhas already been processed. This dialog box will not halt the execution, andyou can call the procedure sequentially during a timely task to change eitherthe displayed message or the length of the progress bar.
A scalar string expression containing the text you want to display inthe dialog box.
A scalar value between 0 and 100. It is used to set the length of theprogress bar at the bottom of the dialog box. If this argument is omit-ted then the progress bar is not displayed.
The progress dialog box does not adjust the length of the progress baritself, so you must do it yourself by sequentially calling the procedurewith an increasing percentage. The progress dialog box is automaticallyremoved from the screen if the execution terminates. If you want to re-move the dialog box yourself, then you should call DialogProgress with anempty message string: DialogProgress("").
With the procedure StatusMessage you can display a short message in the statusbar at the bottom of the Aimms window.
A scalar string expression containing the text you want to display inthe status bar.
If you have set the status bar to be hidden (via the project options), thenthe message will not be visible to the user.
Kyäni Nitro FXTM and Kyäni Nitro XtremeTM: The Science Behind Kyäni’s Nitric Oxide Precursors The statements and products referenced in this document and have not been evaluated by the United States Food and Drug Administration (FDA). The Kyäni products are not intended to diagnose, treat, cure or prevent any disease or condition. The information in this document is intended as a source
1"THE PROVISION OF THE INFORMATION CONTAINED IN THIS REPORT IS SUBJECT TO THE TERMS AND CONDITIONS CONTAINED ON THE BACK HERE OF." Industry Canada, NUANS 5PAGE (TESTS) AFR ? HEWLETT-PACKARD (CANADA) CO. 77382780 PAGE 1/5 CANADA 2003Jn25 =============================================================================== HEWLETT-PACKARD (CANADA) CO. CD 77382780 2003Jn25 PROP.(TESTS) HEWLETT-P
AIMMS Function Reference - Dialog Functions
This file contains only one chapter of the book. For a free download of thecomplete book in pdf format, please visit
Aimms supports the following functions for simple interaction with the enduser.
The procedure DialogAsk displays a small dialog box containing a message andtwo or three buttons. Usually these buttons are an OK and Cancel, or Yes, Noand Cancel, but they can contain any text you want. The procedure returnsthe number of the button that is pressed by the user.
The procedure DialogError displays a small dialog box containing a specifiederror message and an OK button. The execution will be halted until the userpresses the OK button.
The procedure DialogGetColor displays a standard Windows color selection di-alog box. The procedure returns the color (RGB values) selected by the user.
The procedure DialogGetDate displays a standard Windows date selection dia-log box. The procedure returns the date (in the specified format) selected bythe user.
The procedure DialogGetElementByData is an extension of the procedure Di-alogGetElementByText. Instead of only showing a list box with only a singlestring per element, this procedure allows you to show a list box with multi-ple columns of text per element. The text that is displayed in each columnis specified via a 2-dimensional string parameter. The first dimension of thisparameter corresponds to the rows of the list box, the second dimension cor-responds to the column in the listbox.
The procedure DialogGetElement displays a dialog box in which the user canselect an element from a list of set elements.
The procedure DialogGetElementByText displays a dialog box in which the usercan select an element from a set. However, other than DialogGetElement, thisprocedure does not show a list of element names but a list of strings, whichare given as a separate argument to the procedure.
The procedure DialogGetNumber displays a small dialog box in which the usercan enter a single numerical value. The dialog box remains on the screen (andthus halts the execution) until the user presses either the OK or the Cancelbutton.
The procedure DialogGetPassword displays a small dialog box in which the usercan enter a password string. In the dialog box the string is presented by asequence of asterisks. The dialog box remains on the screen (and thus haltsthe execution) until the user presses either the OK or the Cancel button.
The procedure DialogGetString displays a small dialog in which the user canenter a text string. The dialog remains on the screen (and thus halts the exe-cution) until the user presses either the OK or the Cancel button.
The procedure DialogMessage displays a small dialog box containing a specifiedinformational message and an OK button. The execution will be halted untilthe user presses the OK button.
The procedure DialogProgress displays a small dialog box containing a speci-fied message and a progress bar that can indicate how much of a specific taskhas already been processed. This dialog box will not halt the execution, andyou can call the procedure sequentially during a timely task to change eitherthe displayed message or the length of the progress bar.
With the procedure StatusMessage you can display a short message in the statusbar at the bottom of the Aimms window.