API Component.GetInteractive: Difference between revisions
No edit summary |
XML Import to change Variable types into Variable Types |
||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[Variable Types|HANDLE]] ''Target'' | ||
:The component to read the state from | :The component to read the state from | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
| Line 16: | Line 16: | ||
==Return value== | ==Return value== | ||
[[Variable | [[Variable Types|BOOL]] | ||
Returns true if the operation is a success, else false | Returns true if the operation is a success, else false | ||
Revision as of 11:08, 10 June 2013
<sidebar>API contents</sidebar> Gets whether a component can interact with the mouse
Parameters
HANDLE Target
- The component to read the state from
- The default value for this parameter is: this
Return value
Returns true if the operation is a success, else false
Detailed description
An interactive component responds to mouse clicks and other user interface events.
If a component is not interactive, it can not be clicked on by the mouse and will be ignored in mouse-click tests.
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Component.GetInteractive(target)
No additional information