Difference between revisions of "API System.EnableEvent"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
wiki page name
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
==SystemEnableEvent==
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''EnableEvent'''
 +
|-
 +
| colspan="2" | Allows an event to be fired or removes the ability for an event to fire - this may be nested 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" | The component that would usually recieve the event 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | MsgName
 +
|-
 +
| colspan="2" | The quoted class.name formatted name of the event to release 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Enable
 +
|-
 +
| colspan="2" | True to enable the event, 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''
 +
|}
  
−
Allows an event to be fired or removes the ability for an event to fire - this may be nested
 
−
----
 
  
−
===Parameters===
+
==Detailed description==
−
''[[Variable types|HANDLE]] Target''
 
−
:The component that would usually recieve the event
 
  
−
''[[Variable types|STRING]] MsgName''
 
−
:The quoted class.name formatted name of the event to release
 
  
−
''[[Variable types|BOOL]] Enable''
 
−
:True to enable the event, false to disable
 
  
−
===Return value===
+
==Examples==
−
''This call does not return a value''
+
===Calling in a calculation===
−
 
+
* Add to a calculation icon: <pre class="brush:[cpp]">::System.EnableEvent(target, "msgname", false)</pre>
−
===Detailed description===
 
−
''No additional information''
 
−
 
 
−
===Examples===
 
−
====Calling in a calculation:====
 
−
* Add to a calculation icon: ::System.EnableEvent(target, "msgname", false)
 

Latest revision as of 11:55, 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

Examples

Calling in a calculation

  • Add to a calculation icon: 
    ::System.EnableEvent(target, "msgname", false)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_System.EnableEvent&oldid=30344"