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

Latest revision as of 14:23, 13 July 2026

Author	Matrix Ltd
Version	1.0
Category	Matrix Tools

FCD helper component

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

GetIntListItem

	GetIntListItem
Gets a list item from an integer and a textual name Suitable for writing to a property filter Newline is added
- UINT	Index

- STRING	Name

- STRING	Return

GetPropertyList

	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
- STRING	FCDPath

- UINT	Index
A zero based index of the path to find
- STRING	IxName

- STRING	Text

- STRING	Return

GetStrListItem

	GetStrListItem
Gets a list item from a string index and a textual name Suitable for writing to a property filter Newline is added
- STRING	Index

- STRING	Name

- STRING	Return

Register

	Register
Registers a property to update when the FCD changes
- HANDLE	Dest

- STRING	PropName

- STRING	FCDPath

- UINT	INdex
A zero based index of the path to find
- STRING	IxAttr

- STRING	NameAttr

- VOID	Return

Property reference

	Properties

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

@@ Line 14: / Line 14: @@
 ==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: [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==
@@ Line 73: / Line 67: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 81: / Line 81: @@
 ==Macro reference==
-===GetStrListItem===
+===GetIntListItem===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStrListItem'''
+| width="90%" class="mtx-class-macrohead" | '''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 &nbsp;
+| 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-string-icon.png]] - STRING
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" | Index
 |-
@@ Line 105: / Line 105: @@
-===GetIntListItem===
+===GetPropertyList===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''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" 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-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''
+|}
+===GetStrListItem===
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''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
 |-
@@ Line 130: / Line 164: @@
 ===Register===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Register'''
+| width="90%" class="mtx-class-macrohead" | '''Register'''
 |-
 | colspan="2" | Registers a property to update when the FCD changes &nbsp;
@@ Line 173: / Line 207: @@
-===GetPropertyList===
+==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetPropertyList'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
-| 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''
 |}
+==Component Source Code==
+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]
-==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
-|-
-|}

SteveT (talk | contribs)