Component: Property Manager (Storage )

From Flowcode Help
Revision as of 13:49, 7 July 2021 by BenR (talk | contribs) (XML import)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search
Author Matrix TSL
Version 1.0 (Release)
Category Storage


Image 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.

Examples

No additional examples


Downloadable macro reference

This component does not contain any downloadable macros

Simulation macro reference

Save

Saves the registered property values to the config file.

Parameters

This macro has no parameters


Return value

This call does not return a value


Load

Loads the registered property values from the config file.

Parameters

This macro has no parameters


Return value

This call does not return a value


RegisterProperty

Registers a property to be saved or loaded

Parameters

<- 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



Property reference

Filepath

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.

$(srcdir) default sets the path to be the same as the Flowcode project path.

Filename

This property is of type Line of text and can be referenced with the variable name Filename.

No additional information


Show Dialogue On Load

This property is of type True or false and can be referenced with the variable name DialogueOnLoad.

Forces the user to check if they are sure before loading saved values.

Show Dialogue On Save

This property is of type True or false and can be referenced with the variable name DialogueOnSave.

Forces the user to check if they are sure before overwriting previous values.