Difference between revisions of "API System.EnableEvent"

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
−
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Allows an event to be fired or removes the ability for an event to fire - this may be nested
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''EnableEvent'''
−
====Class hierarchy====
+
|-
−
[[API System|System]]
+
| colspan="2" | Allows an event to be fired or removes the ability for an event to fire - this may be nested&nbsp;
−
:[[API System|EnableEvent]]
+
|-
−
</div>
+
|-
−
__TOC__
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
−
 
+
| width="90%" | Target
−
==Parameters==
+
|-
−
[[Variable Types|HANDLE]] ''Target''
+
| colspan="2" | The component that would usually recieve the event&nbsp;
−
:The component that would usually recieve the event
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
[[Variable Types|STRING]] ''MsgName''
+
| width="90%" | MsgName
−
:The quoted class.name formatted name of the event to release
+
|-
−
 
+
| colspan="2" | The quoted class.name formatted name of the event to release&nbsp;
−
[[Variable Types|BOOL]] ''Enable''
+
|-
−
:True to enable the event, false to disable
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
−
 
+
| width="90%" | Enable
−
 
+
|-
−
==Return value==
+
| colspan="2" | True to enable the event, false to disable&nbsp;
−
''This call does not return a value''
+
|-
 +
| 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''
 +
|}
  
  

Revision as of 11:42, 16 January 2023

Fc9-comp-macro.png EnableEvent
Allows an event to be fired or removes the ability for an event to fire - this may be nested 
Fc9-h32-icon.png - HANDLE Target
The component that would usually recieve the event 
Fc9-string-icon.png - STRING MsgName
The quoted class.name formatted name of the event to release 
Fc9-bool-icon.png - BOOL Enable
True to enable the event, false to disable 
Fc9-void-icon.png - NONE Return


Detailed description

No additional information


Examples

Calling in a calculation

  • Add to a calculation icon: 
    ::System.EnableEvent(target, "msgname", false)

No additional examples

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_System.EnableEvent&oldid=30041"