Difference between revisions of "API Component.SetInteractive"

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
<sidebar>API Contents</sidebar>
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
Sets whether a component can interact with the mouse
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetInteractive'''
 
+
|-
<div style="width:25%; float:right" class="toc">
+
| colspan="2" | Sets whether a component can interact with the mouse&nbsp;
====Class hierarchy====
+
|-
[[API Component|Component]]
+
|-
:[[API Component|SetInteractive]]
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
</div>
+
| width="90%" | Target
__TOC__
+
|-
 
+
| colspan="2" | The component to set the state for&nbsp;
==Parameters==
+
|-
[[Variable Types|HANDLE]] ''Target''
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
:The component to set the state for
+
| width="90%" | Enabled
:''The default value for this parameter is: '''''this'''
+
|-
 
+
| colspan="2" | True to enable, false to disable&nbsp;
[[Variable Types|BOOL]] ''Enabled''
+
|-
:True to enable, false to disable
+
| 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''
 
+
|}
==Return value==
 
''This call does not return a value''
 
  
  
Line 33: Line 31:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.SetInteractive(target, true)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.SetInteractive(target, true)</pre>
 
''<span style="color:red;">No additional examples</span>''
 

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)