Module:Editor
Version:2.2.1 +
User:Developer
Object Type:Action Object
Description
A FileSaver is used to store data generated by an XmlBuilder, GraphConverter , XmlConverter (from version 20.10) or Formula (from version 23.09) to a file. The first will result in a XML-file containing the data. The second will result in an image of the graph. The latter will result in text obtained from a XSLT conversion of XML data.
Properties
Condition
This property indicates under which condition the FileSaver is to be executed. If nothing is entered the FileSaver will always be executed. If a condition has been filled in the FileSaver will only be executed if the Condition is 'True'. In the property a Formula of type Boolean can be entered as well as a Fixed or a Reference to another object of type Boolean.
Data
In the property Data a reference has to be made to the XmlBuilder, GraphConverter, XmlConverter (from version 20.10) (see below) or Formula (from version 23.09) which contains the data that has to be saved.
DebugLogMode (from version 4.1)
Indicates the level of detail of debug information that is logged when running a Futurama application (website, webservice, console application) to the trace, a logfile, a database etc. The possible values are:
- None: no debug information is logged
- Simple: only basic information is given
- Extended: in addition to the information in the Simple mode the values of all the properties of the object are shown
FileName
The property FileName has to contain the name of the file including the path. For example 'C:\temp\test.xml' when Data refers to an XMLBuilder or 'C:\temp\graph.jpg', 'C:\temp\graph.gif' or any other graphics file format when Data refers to a GraphConverter or 'C:\temp\output.txt' when Data refers to an XMLConverter. Any folders in the path that do not exist will be created automatically. Note that the application has to have write permissions on the location specified.
File permission errors are considered application permission issues, and will therefore be not be displayed to the user (FileSaver fails with a general error message). However, they will be logged explicitly if you have configured logging.
IsPublic
Possible values are True or False. If the value is False, then the object can only be used within the document where it is created. If the value is True, then also from other Futurama documents can be referred to this object. This means that changes in the object also affect the document in which is referred to this object. If the value is True and you attempt to move or delete the object, a warning will be given. To limit these warnings to a minimum it is recommended to set IsPublic to True only when necessary.
(Name)
The name of the object.
Comment
Here a comment can be entered. For example a short description of the object.
ID
The unique identification number of the object. This number is automatically generated by Futurama on the moment of creation. This number can be used when searching for a certain object in the Find Window.