Difference between revisions of "Component: FCD helper (Matrix Tools)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Matrix Tools
 
| Matrix Tools
 
|}
 
|}
  
  
 +
==FCD helper component==
 +
A helper control to query the current Flowcode definition XML file. 
  
−
==[[File:Component Icon fc3c670c_502a_418f_a123_649179752383.png|Image]] FCD helper component==
+
==Component Pack==
−
A helper control to query the current FCD file
 
  
 +
FREE
  
−
==Examples==
+
==Detailed description==
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Downloadable macro reference==
 
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>GetStrListItem</tt></u></span>===
 
−
Gets a list item from a string index and a textual name
 
  
−
Suitable for writing to a property filter
 
  
−
Newline is added
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|STRING]] ''Index''
 
  
−
:[[Variable Types|STRING]] ''Name''
 
  
 +
''No detailed description exists yet for this component''
  
−
'''Return value'''
+
==Examples==
  
−
:[[Variable Types|STRING]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>GetIntListItem</tt></u></span>===
 
−
Gets a list item from an integer and a textual name
 
  
−
Suitable for writing to a property filter
 
  
−
Newline is added
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|UINT]] ''Index''
 
  
−
:[[Variable Types|STRING]] ''Name''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|STRING]]
 
  
 +
''<span style="color:red;">No additional examples</span>''
  
−
===<span style="font-weight: normal;"><u><tt>Register</tt></u></span>===
 
−
Registers a property to update when the FCD changes
 
  
−
'''Parameters'''
+
==Downloadable macro reference==
  
−
:[[Variable Types|HANDLE]] ''Dest''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStrListItem'''
 +
|-
 +
| colspan="2" | Gets a list item from a string index and a textual name Suitable for writing to a property filter Newline is added &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Name
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:[[Variable Types|STRING]] ''PropName''
 
  
−
:[[Variable Types|STRING]] ''FCDPath''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIntListItem'''
 +
|-
 +
| colspan="2" | Gets a list item from an integer and a textual name Suitable for writing to a property filter Newline is added &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Name
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:[[Variable Types|UINT]] ''INdex''
 
−
::A zero based index of the path to find
 
  
−
:[[Variable Types|STRING]] ''IxAttr''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Register'''
 +
|-
 +
| colspan="2" | Registers a property to update when the FCD changes &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Dest
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | PropName
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | FCDPath
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | INdex
 +
|-
 +
| colspan="2" | A zero based index of the path to find&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | IxAttr
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | NameAttr
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:[[Variable Types|STRING]] ''NameAttr''
 
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetPropertyList'''
 +
|-
 +
| colspan="2" | Gets a filter list suitable for adding to a property Uses the [u]IxName[/u] as the index into the list Uses the [u]Text[/u] as the line to show in list-boxes &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | FCDPath
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | A zero based index of the path to find&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | IxName
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Text
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>GetPropertyList</tt></u></span>===
+
==Property reference==
−
Gets a filter list suitable for adding to a property
 
  
−
Uses the <nowiki/>[u<nowiki/>]IxName<nowiki/>[/u<nowiki/>] as the index into the list
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Uses the <nowiki/>[u<nowiki/>]Text<nowiki/>[/u<nowiki/>] as the line to show in list-boxes
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
'''Parameters'''
+
|-
−
 
+
|}
−
:[[Variable Types|STRING]] ''FCDPath''
 
−
 
 
−
:[[Variable Types|UINT]] ''Index''
 
−
::A zero based index of the path to find
 
−
 
 
−
:[[Variable Types|STRING]] ''IxName''
 
−
 
 
−
:[[Variable Types|STRING]] ''Text''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:[[Variable Types|STRING]]
 
−
 
 
−
 
 
−
 
 
−
 
 
−
==Property reference==
 
−
''This component does not contain any properties''
 

Latest revision as of 17:21, 9 November 2022

Author Matrix Ltd
Version 1.0
Category Matrix Tools


FCD helper component

A helper control to query the current Flowcode definition XML file.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png GetStrListItem
Gets a list item from a string index and a textual name Suitable for writing to a property filter Newline is added  
Fc9-string-icon.png - STRING Index
 
Fc9-string-icon.png - STRING Name
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetIntListItem
Gets a list item from an integer and a textual name Suitable for writing to a property filter Newline is added  
Fc9-u16-icon.png - UINT Index
 
Fc9-string-icon.png - STRING Name
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png Register
Registers a property to update when the FCD changes  
Fc9-h32-icon.png - HANDLE Dest
 
Fc9-string-icon.png - STRING PropName
 
Fc9-string-icon.png - STRING FCDPath
 
Fc9-u16-icon.png - UINT INdex
A zero based index of the path to find 
Fc9-string-icon.png - STRING IxAttr
 
Fc9-string-icon.png - STRING NameAttr
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetPropertyList
Gets a filter list suitable for adding to a property Uses the [u]IxName[/u] as the index into the list Uses the [u]Text[/u] as the line to show in list-boxes  
Fc9-string-icon.png - STRING FCDPath
 
Fc9-u16-icon.png - UINT Index
A zero based index of the path to find 
Fc9-string-icon.png - STRING IxName
 
Fc9-string-icon.png - STRING Text
 
Fc9-string-icon.png - STRING Return



Property reference

Fc9-prop-icon.png Properties
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_FCD_helper_(Matrix_Tools)&oldid=28650"