ModalWindow (your_wind_id)

Result Type:  string

Definition:  Instantiates a modal window using the UI form with identifier your_wind_id (i.e. the name you gave the form in the script editor). Your window definition should include a default (OK) button and usually a Cancel button. The user clicking either of these will cause the window to close. If neither of these buttons is present, the window will have a close box which will have a similiar effect to Cancel.

The return value of ModalWindow will be the identifier of the last control hit (generally this will be the id of the cancel button or the OK button).

The window will receive the usual window-related messages. e.g: You can write a Before handler named Before:your_wind_id(windowRef) in which you can set up the state of the window's controls.

Windows automatically remember their last size and location (this information is written into a file named script_id.properties. You can set the values of the properties your_wind_id_left, your_wind_id_top, your_wind_id_right, and your_wind_id_bottom before instantiating the window to override the size and location.

Availability:  available within MWScript handlers.

See Also:

CreateListWindow: Instantiate a modeless custom database table list window

CreateWindow: Instantiate a modeless custom window

ModalListWindow: Instantiate a modal custom database table list window