CloseQuery
PowerScript event
Description
Occurs when a window is closed, before the Close event.
Event ID
|
Event ID |
Objects |
|---|---|
|
pbm_closequery |
Window |
Arguments
None
Return Values
Long.
Return code choices (specify in a RETURN statement):
0 — Allow the window to be closed
1 — Prevent the window from closing
Usage
If the CloseQuery event returns a value of 1, the closing of the
window is aborted and the Close event that usually follows CloseQuery does
not occur.
If the user closes the window with the Close box (instead of using
buttons whose scripts can evaluate the state of the data in the window),
the CloseQuery event still occurs, allowing you to prompt the user about
saving changes or to check whether data the user entered is valid.
Obsolete techniques
You no longer need to set the ReturnValue property of the Message
object. Use a RETURN statement instead.
Examples
This statement in the CloseQuery event for a window asks if the user
really wants to close the window and if the user answers no, prevents it
from closing:
|
1 2 3 4 5 6 |
IF MessageBox("Closing window", "Are you sure?", & Question!, YesNo!) = 2 THEN RETURN 1 ELSE RETURN 0 END IF |
This script for the CloseQuery event tests to see if the DataWindow
dw_1 has any pending changes. If it has, it asks the user whether to
update the data and close the window, close the window without updating,
or leave the window open without updating:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
integer li_rc // Accept the last data entered into the datawindow dw_1.AcceptText() //Check to see if any data has changed IF dw_1.DeletedCount()+dw_1.ModifiedCount() > 0 THEN li_rc = MessageBox("Closing", & "Update your changes?", Question!, & YesNoCancel!, 3) //User chose to up data and close window IF li_rc = 1 THEN Window lw_window lw_window = w_genapp_frame.GetActiveSheet() lw_window.TriggerEvent("ue_update") RETURN 0 //User chose to close window without updating ELSEIF li_rc = 2 THEN RETURN 0 //User canceled ELSE RETURN 1 END IF ELSE // No changes to the data, window will just close RETURN 0 END IF |
See also