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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| 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
 
| Storage  
 
| Storage  
 
|}
 
|}
  
  
 +
==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.
  
−
==[[File:Component Icon 819d0c05_aaa2_4431_84dc_d40f3eee1b54.png|Image]] Property Manager component==
+
==Component Pack==
−
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.
 
  
−
==Examples==
+
FREE
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
 
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>Save</tt></u></span>===
 
−
Saves the registered property values to the config file.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Load</tt></u></span>===
+
''No detailed description exists yet for this component''
−
Loads the registered property values from the config file.
 
  
−
'''Parameters'''
+
==Examples==
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>RegisterProperty</tt></u></span>===
 
−
Registers a property to be saved or loaded
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|<- STRING]] ''PropertyVariable''
 
−
::Property variable exposed to the user, highlight property and variable is shown at the bottom of the window.
 
−
::''This parameter may be returned back to the caller''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
 +
''<span style="color:red;">No additional examples</span>''
  
  
 +
==Downloadable macro reference==
  
−
==Property reference==
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
<span style="font-weight: normal;"><u>Filepath</u></span>
+
|-
 +
| 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.&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''
 +
|}
  
−
This property is of type ''Directory'' and can be referenced with the variable name ''CSV_ReadWrite1::Filepath''.
 
  
−
Sets the path of the file to write to.
+
{| 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.&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''
 +
|}
  
−
$(srcdir) default sets the path to be the same as the Flowcode project path.
 
  
−
<span style="font-weight: normal;"><u>Filename</u></span>
+
{| 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&nbsp;
 +
|-
 +
|-
 +
| 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.&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''
 +
|}
  
−
This property is of type ''Line of text'' and can be referenced with the variable name ''Filename''.
 
  
−
''<span style="color:red;">No additional information</span>''
 
  
  
 +
==Property reference==
  
−
<span style="font-weight: normal;"><u>Show Dialogue On Load</u></span>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''DialogueOnLoad''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
Forces the user to check if they are sure before loading saved values.
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Show Dialogue On Save</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-20-icon.png]]
−
 
+
| width="90%" | Filepath
−
This property is of type ''True or false'' and can be referenced with the variable name ''DialogueOnSave''.
+
|-
−
 
+
| 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.&nbsp;
−
Forces the user to check if they are sure before overwriting previous values.
+
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Filename
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|}

Latest revision as of 17:22, 9 November 2022

Author Matrix TSL
Version 1.0
Category Storage


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 Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

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


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


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



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/wikiv9/index.php?title=Component:_Property_Manager_(Storage_)&oldid=28730"