Jump to content

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

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,426 edits
XML import
 
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(20 intermediate revisions by 2 users 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. 
==Detailed description==






==[[File:Component Icon fc3c670c_502a_418f_a123_649179752383.png|Image]] FCD helper component==
A helper control to query the current FCD file




==Examples==
''<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''




'''Return value'''


:[[Variable Types|STRING]]
''No detailed description exists yet for this component''


==Examples==


===<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="font-weight: normal;"><u><tt>Register</tt></u></span>===
Registers a property to update when the FCD changes


'''Parameters'''


:[[Variable Types|HANDLE]] ''Dest''


:[[Variable Types|STRING]] ''PropName''


:[[Variable Types|STRING]] ''FCDPath''


:[[Variable Types|UINT]] ''INdex''
::A zero based index of the path to find


:[[Variable Types|STRING]] ''IxAttr''


:[[Variable Types|STRING]] ''NameAttr''




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>GetPropertyList</tt></u></span>===
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
''<span style="color:red;">No additional examples</span>''


Uses the <nowiki/>[u<nowiki/>]Text<nowiki/>[/u<nowiki/>] as the line to show in list-boxes


'''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]]




==Macro reference==
===GetIntListItem===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}
===GetPropertyList===
{| 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" | [[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
|-
| 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''
|}
===Register===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}




==Property reference==
==Property reference==
''This component does not contain any properties''
 
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|}
 
==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]

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

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_FCD_helper_(Matrix_Tools)&oldid=46475"