Difference between revisions of "GetButtonPressed"

From GECK

(Improve wording to make return value more clear)
(including example for extra clarity)
Line 7: Line 7:
 
  set buttonVar to GetButtonPressed  
 
  set buttonVar to GetButtonPressed  
  
The first time this is called after a [[ShowMessage]] button has been pressed, it returns the index of the button that was pressed. At all other times it returns -1.
+
The first time this is called after a [[ShowMessage]] button has been pressed, it returns the index of the button that was pressed, starting at zero. At all other times it returns -1.
 
+
  
 
==Notes==
 
==Notes==
 
* This will only react to a [[ShowMessage]] call from within the same script.
 
* This will only react to a [[ShowMessage]] call from within the same script.
* The button indices are shown in the GECK when editing the message object and remain the same even if certain buttons are hidden with conditions.
+
* The button indices are shown in the GECK when editing the message object and remain the same even if certain buttons are hidden with conditions.  So, if a Message has 3 buttons, GetButtonPressed will return '''2''' when the last one is pressed even if that is the only button actually being displayed.
  
 
=='''See Also'''==
 
=='''See Also'''==

Revision as of 01:05, 2 January 2009

Description

GetButtonPressed is used to determine which button has been selected after a message box has been displayed using ShowMessage.

Syntax:

GetButtonPressed 

Example:

set buttonVar to GetButtonPressed 

The first time this is called after a ShowMessage button has been pressed, it returns the index of the button that was pressed, starting at zero. At all other times it returns -1.

Notes

  • This will only react to a ShowMessage call from within the same script.
  • The button indices are shown in the GECK when editing the message object and remain the same even if certain buttons are hidden with conditions. So, if a Message has 3 buttons, GetButtonPressed will return 2 when the last one is pressed even if that is the only button actually being displayed.

See Also

ShowMessage

Personal tools