Jump to content

Component: Property Manager (Utility ): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,422 edits
No edit summary
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(11 intermediate revisions by 2 users not shown)
Line 15: Line 15:
Allows property values exposed to the user to be saved and loaded using an external file. Simplifies the process of storing and retreiving the property values. Also works with nested properties using the "::" syntax.
Allows property values exposed to the user to be saved and loaded using an external file. Simplifies the process of storing and retreiving the property values. Also works with nested properties using the "::" syntax.


==Component Source Code==
==Detailed description==
 
 
 
 


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_PropertyManager.fcsx FC_Comp_Source_PropertyManager.fcsx]


==Detailed description==




Line 40: Line 42:


==Examples==
==Examples==




Line 61: Line 69:




==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;" | '''Save'''
|-
| colspan="2" | Saves the registered property values to the config file. 
|-
|-
| 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;" | '''Load'''
|-
| colspan="2" | Loads the registered property values from the config file. 
|-
|-
| 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;" | '''RegisterProperty'''
|-
| colspan="2" | Registers a property to be saved or loaded 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | PropertyVariable
|-
| colspan="2" | Property variable exposed to the user, highlight property and variable is shown at the bottom of the window. 
|-
| 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==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
==Macro reference==
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-20-icon.png]]
| width="90%" | Filepath
|-
| colspan="2" | Sets the path of the file to write to. $(srcdir) default sets the path to be the same as the Flowcode project path. 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Filename
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Dialogue On Load
|-
| colspan="2" | Forces the user to check if they are sure before loading saved values. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Dialogue On Save
|-
| colspan="2" | Forces the user to check if they are sure before overwriting previous values. 
|}==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===Load===
{| 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;" | '''Save'''
| width="90%" class="mtx-class-macrohead" | '''Load'''
|-
|-
| colspan="2" | Saves the registered property values to the config file. 
| colspan="2" | Loads the registered property values from the config file. 
|-
|-
|-
|-
Line 151: Line 95:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===RegisterProperty===
{| 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;" | '''Load'''
| width="90%" class="mtx-class-macrohead" | '''RegisterProperty'''
|-
| colspan="2" | Registers a property to be saved or loaded. The property name should also include the component name e.g.  Top level property - "PropVarName" Component property - "ComponentName::PropVarName" 
|-
|-
| colspan="2" | Loads the registered property values from the config file. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | PropertyVariable
|-
| colspan="2" | Property variable exposed to the user, highlight property and variable is shown at the bottom of the window. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 164: Line 114:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===Save===
{| 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;" | '''RegisterProperty'''
| width="90%" class="mtx-class-macrohead" | '''Save'''
|-
|-
| colspan="2" | Registers a property to be saved or loaded 
| colspan="2" | Saves the registered property values to the config file. 
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | PropertyVariable
|-
| colspan="2" | Property variable exposed to the user, highlight property and variable is shown at the bottom of the window. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| 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''
|}
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-type-20-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Filepath
| width="90%" | Filepath
|-
|-
| colspan="2" | Sets the path of the file to write to. $(srcdir) default sets the path to be the same as the Flowcode project path. 
| colspan="2" | Directory path on the system of where to store the file. $(srcdir) is the Flowcode project directory. 
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
Line 212: Line 156:
| colspan="2" | Forces the user to check if they are sure before overwriting previous values. 
| colspan="2" | Forces the user to check if they are sure before overwriting previous values. 
|}
|}
==Component Source Code==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_PropertyManager.fcsx FC_Comp_Source_PropertyManager.fcsx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_PropertyManager.fcsx FC_Comp_Source_PropertyManager.fcsx]

Latest revision as of 14:23, 13 July 2026

Author Matrix TSL
Version 1.0
Category Utility


Property Manager component

Allows property values exposed to the user to be saved and loaded using an external file. Simplifies the process of storing and retreiving the property values. Also works with nested properties using the "::" syntax.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

Load

Load
Loads the registered property values from the config file. 
- VOID Return


RegisterProperty

RegisterProperty
Registers a property to be saved or loaded. The property name should also include the component name e.g. Top level property - "PropVarName" Component property - "ComponentName::PropVarName" 
- STRING PropertyVariable
Property variable exposed to the user, highlight property and variable is shown at the bottom of the window. 
- VOID Return


Save

Save
Saves the registered property values to the config file. 
- VOID Return


Property reference

Properties
Filepath
Directory path on the system of where to store the file. $(srcdir) is the Flowcode project directory. 
Filename
 
Show Dialogue On Load
Forces the user to check if they are sure before loading saved values. 
Show Dialogue On Save
Forces the user to check if they are sure before overwriting previous values. 

Component Source Code

Please click here to download the component source project: FC_Comp_Source_PropertyManager.fcsx

Please click here to view the component source code (Beta): FC_Comp_Source_PropertyManager.fcsx

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Property_Manager_(Utility_)&oldid=46787"