Difference between revisions of "Component: Property Manager (Utility )"

From Flowcode Help
Jump to navigationJump to search
 
(6 intermediate revisions by the same user not shown)
Line 16: Line 16:
  
 
==Component Source Code==
 
==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]
 
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==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
  
  
Line 40: Line 48:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
  
  
Line 61: Line 75:
  
  
−
==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''
 
−
|}
 
  
  
 +
 +
 +
 +
 +
 +
 +
 +
==Macro reference==
 +
 +
===Load===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 89: Line 101:
  
  
 +
===RegisterProperty===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 107: Line 120:
  
  
−
 
+
===Save===
−
 
 
−
==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'''
 
−
|-
 
−
|-
 
−
| 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;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 149: Line 132:
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| 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''
 
−
|}
 
−
 
−
 
  
  

Latest revision as of 13:12, 7 February 2023

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.

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

Load

Fc9-comp-macro.png Load
Loads the registered property values from the config file. 
Fc9-void-icon.png - VOID Return


RegisterProperty

Fc9-comp-macro.png RegisterProperty
Registers a property to be saved or loaded 
Fc9-string-icon.png - STRING PropertyVariable
Property variable exposed to the user, highlight property and variable is shown at the bottom of the window. 
Fc9-void-icon.png - VOID Return


Save

Fc9-comp-macro.png Save
Saves the registered property values to the config file. 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-20-icon.png Filepath
Sets the path of the file to write to. $(srcdir) default sets the path to be the same as the Flowcode project path. 
Fc9-type-10-icon.png Filename
 
Fc9-type-7-icon.png Show Dialogue On Load
Forces the user to check if they are sure before loading saved values. 
Fc9-type-7-icon.png Show Dialogue On Save
Forces the user to check if they are sure before overwriting previous values. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Property_Manager_(Utility_)&oldid=38276"