Jump to content

API System.EnableEvent: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import
JonnyW (talk | contribs)
XML Import to change Variable types into Variable Types
Line 10: Line 10:


==Parameters==
==Parameters==
[[Variable types|HANDLE]] ''Target''
[[Variable Types|HANDLE]] ''Target''
:The component that would usually recieve the event
:The component that would usually recieve the event


[[Variable types|STRING]] ''MsgName''
[[Variable Types|STRING]] ''MsgName''
:The quoted class.name formatted name of the event to release
:The quoted class.name formatted name of the event to release


[[Variable types|BOOL]] ''Enable''
[[Variable Types|BOOL]] ''Enable''
:True to enable the event, false to disable
:True to enable the event, false to disable



Revision as of 11:09, 10 June 2013

<sidebar>API contents</sidebar> Allows an event to be fired or removes the ability for an event to fire - this may be nested

Class hierarchy

System

EnableEvent

Parameters

HANDLE Target

The component that would usually recieve the event

STRING MsgName

The quoted class.name formatted name of the event to release

BOOL Enable

True to enable the event, false to disable


Return value

This call does not return a value


Detailed description

No additional information


Examples

Calling in a calculation

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

No additional information