Difference between revisions of "API Component.SetInteractive"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Sets whether a component can interact with the mouse
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetInteractive'''
 +
|-
 +
| colspan="2" | Sets whether a component can interact with the mouse&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" | The component to set the state for&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Enabled
 +
|-
 +
| colspan="2" | True to enable, false to disable&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===Parameters===
+
==Detailed description==
−
''[[Variable types|HANDLE]] Target''
+
An interactive component responds to mouse clicks and other user interface events.
−
:The component to set the state for
 
−
:''The default value for this parameter is: '''''this'''
 
  
−
''[[Variable types|BOOL]] Enabled''
+
If a component is not interactive, it can not be clicked on by the mouse and will be ignored in mouse-click tests.
−
:True to enable, false to disable
 
  
−
===Return value===
 
−
''This call does not return a value''
 
  
−
===Detailed description===
+
==Examples==
−
''No additional information''
+
===Calling in a calculation===
−
 
+
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.SetInteractive(target, true)</pre>
−
===Examples===
 
−
====Calling in a calculation====
 
−
* Add to a calculation icon: ::Component.SetInteractive(target, true)
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png SetInteractive
Sets whether a component can interact with the mouse 
Fc9-h32-icon.png - HANDLE Target
The component to set the state for 
Fc9-bool-icon.png - BOOL Enabled
True to enable, false to disable 
Fc9-void-icon.png - NONE Return


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

  • Add to a calculation icon: 
    ::Component.SetInteractive(target, true)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Component.SetInteractive&oldid=30141"