Component: FCD helper (Matrix Tools): Difference between revisions
No edit summary |
No edit summary |
||
| Line 16: | Line 16: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/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] | 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 40: | Line 44: | ||
==Examples== | ==Examples== | ||
| Line 62: | Line 68: | ||
==Macro reference== | ==Macro reference== | ||
{| 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 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | |||
| width="90%" | Index | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | |||
| width="90%" | Name | |||
|- | |||
| colspan="2" | | |||
|- | |||
| 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'' | |||
|} | |||
{| 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 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | |||
| width="90%" | Index | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | |||
| width="90%" | Name | |||
|- | |||
| colspan="2" | | |||
|- | |||
| 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'' | |||
|} | |||
{| 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 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |||
| width="90%" | Dest | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | |||
| width="90%" | PropName | |||
|- | |||
| colspan="2" | | |||
|- | |||
| 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="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%" | IxAttr | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | |||
| width="90%" | NameAttr | |||
|- | |||
| 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="90%" | FCDPath | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | |||
| 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" | | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | |||
| width="90%" | Text | |||
|- | |||
| colspan="2" | | |||
|- | |||
| 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'' | |||
|} | |||
==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''' | |||
|- | |||
|}==Macro reference== | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:25, 20 January 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
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
Property reference
|
Properties |
==Macro reference==
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
Property reference
|
|
Properties |
==Macro reference==
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
Property reference
|
|
Properties |