Difference between revisions of "Component: Property Manager (Utility )"
From Flowcode Help
Jump to navigationJump to search| (3 intermediate revisions by the same user not shown) | |||
| Line 14: | Line 14: | ||
==Property Manager component== | ==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. | 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== | ==Detailed description== | ||
| Line 79: | Line 73: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Macro reference== | ||
===Load=== | ===Load=== | ||
| Line 115: | Line 101: | ||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RegisterProperty''' | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RegisterProperty''' | ||
|- | |- | ||
| − | | colspan="2" | Registers a property to be saved or loaded | + | | 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" |
|- | |- | ||
|- | |- | ||
| Line 128: | Line 114: | ||
| + | ===Save=== | ||
| + | {| 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'' | ||
| + | |} | ||
| Line 138: | Line 136: | ||
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9-type- | + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] |
| width="90%" | Filepath | | width="90%" | Filepath | ||
|- | |- | ||
| − | | colspan="2" | | + | | 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 158: | 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 21:16, 27 January 2026
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Utility |
Contents
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
