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

From Flowcode Help
Jump to navigationJump to search
(10 intermediate revisions by the same user not shown)
Line 15: Line 15:
 
A helper control to query the current Flowcode definition XML file.   
 
A helper control to query the current Flowcode definition XML file.   
  
−
==Component Pack==
+
==Component Source Code==
  
−
FREE
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_fcdhelper.fcfx FC_Comp_Source_fcdhelper.fcfx]
 +
 
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_fcdhelper.fcfx FC_Comp_Source_fcdhelper.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 32: Line 48:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 45: Line 75:
  
  
−
==Downloadable macro reference==
 
  
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
==Macro reference==
 +
 +
===GetIntListItem===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStrListItem'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIntListItem'''
 
|-
 
|-
−
| colspan="2" | Gets a list item from a string index and a textual name Suitable for writing to a property filter Newline is added  
+
| colspan="2" | Gets a list item from an integer and a textual name Suitable for writing to a property filter Newline is added  
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="90%" | Index
 
| width="90%" | Index
 
|-
 
|-
Line 70: Line 111:
  
  
 +
===GetPropertyList===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIntListItem'''
+
| 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  
 
|-
 
|-
−
| colspan="2" | Gets a list item from an integer and a textual name Suitable for writing to a property filter Newline is added  
 
 
|-
 
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | FCDPath
 +
|-
 +
| colspan="2" |  
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="90%" | Index
 
| width="90%" | Index
 +
|-
 +
| colspan="2" | A zero based index of the path to find 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | IxName
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
| width="90%" | Name
+
| width="90%" | Text
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
Line 93: Line 145:
  
  
 +
===GetStrListItem===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Register'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStrListItem'''
 
|-
 
|-
−
| colspan="2" | Registers a property to update when the FCD changes  
+
| colspan="2" | Gets a list item from a string index and a textual name Suitable for writing to a property filter Newline is added  
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
| width="90%" | Dest
+
| width="90%" | Index
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
| width="90%" | PropName
+
| width="90%" | Name
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
−
| width="90%" | FCDPath
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 
 +
 
 +
===Register===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
−
| colspan="2" |  
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Register'''
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+
| colspan="2" | Registers a property to update when the FCD changes  
−
| width="90%" | INdex
 
 
|-
 
|-
−
| colspan="2" | A zero based index of the path to find 
 
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
−
| width="90%" | IxAttr
+
| width="90%" | Dest
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
| width="90%" | NameAttr
+
| width="90%" | PropName
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
−
|-
 
−
| 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''
 
−
|}
 
−
 
−
 
−
{| 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  
 
−
|-
 
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
Line 150: Line 194:
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
−
| width="90%" | Index
+
| width="90%" | INdex
 
|-
 
|-
 
| colspan="2" | A zero based index of the path to find 
 
| colspan="2" | A zero based index of the path to find 
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
| width="90%" | IxName
+
| width="90%" | IxAttr
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
| width="90%" | Text
+
| width="90%" | NameAttr
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
  
  
Line 177: Line 219:
 
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
|-
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
 
 
|-
 
|-
 
|}
 
|}

Revision as of 13:13, 7 February 2023

Author Matrix Ltd
Version 1.0
Category Matrix Tools


FCD helper component

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

Component Source Code

Please click here to download the component source project: FC_Comp_Source_fcdhelper.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_fcdhelper.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

GetIntListItem

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


GetPropertyList

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


GetStrListItem

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


Register

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


Property reference

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