Difference between revisions of "API Component.GetInteractive"

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Gets whether a component can interact with the mouse

HANDLE Target

The component to read the state from

The default value for this parameter is: this

Returns true if the operation is a success, else false

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.

Add to a calculation icon:

result = ::Component.GetInteractive(target)

No additional examples

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+<sidebar>API Contents</sidebar>
 Gets whether a component can interact with the mouse
+<div style="width:25%; float:right" class="toc">
+====Class hierarchy====
+[[API Component|Component]]
+:[[API Component|GetInteractive]]
+</div>
+__TOC__
-===Parameters===
+==Parameters==
-''[[Variable types|HANDLE]] Target''
+[[Variable Types|HANDLE]] ''Target''
 :The component to read the state from
 :''The default value for this parameter is: '''''this'''
-===Return value===
-[[Variable types|BOOL]]
-No additional information
+==Return value==
+[[Variable Types|BOOL]]
-===Detailed description===
+Returns true if the operation is a success, else false
-''No additional information''
-===Examples===
-====Calling in a calculation====
+==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: <pre class="brush:[C]">result = ::Component.GetInteractive(target)</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetInteractive(target)</pre>
+''<span style="color:red;">No additional examples</span>''