| BlueSpray - Help © SchoonerTurtles, Inc. 2012-2015
Introduction
Contents
Getting Started
Download
Navigating
Tutorials
Scripting
Advanced
About
| # Class STFileManager The File STFileManager creates file handles based on the file extension. Note: Some of these are really read-only and need to be filtered from the save extensions Copyright, SchoonerTurtles LLP, 2009 @author Jim Graham #### Static Functions
Returns | Function | Throws
--- | --- | ---
| ConvertFile(String InputFile,String OutputFile) | Exception
| LoadFromFile(String FilePath,STBase TheObject) | Exception
| LoadFromFile(String FilePath,STBase TheObject, boolean ShowSettingsDialogs) | Exception
| SaveToFile(String FilePath,STBase TheObject) | Exception
| SaveToFile(String FilePath,STBase TheObject,boolean ShowDialogs) | Exception
## Static Functions ### ConvertFile(String InputFile,String OutputFile) Exception Converts data from one file format to another. The file extension will determine the file format. Parameters: InputFile - Path to the input file OutputFile - Path to the file to be output Throws: Exception ### LoadFromFile(String FilePath,STBase TheObject) Exception Loads an object from a file. Parameters: FilePath - path to the file on disk TheObject - the object to load the data into Throws: Exception ### LoadFromFile(String FilePath,STBase TheObject, boolean ShowSettingsDialogs) Exception Load from a file into an existing object. Parameters: FilePath - path to the file on disk TheObject - the object to load the data into ShowSettingsDialogs - true to present the user with options if available Throws: Exception ### SaveToFile(String FilePath,STBase TheObject) Exception Saves the object based on its content and the current file path and other settings. Parameters: FilePath - path to the file to save the data into TheObject - the object with the data to save Throws: Exception ### SaveToFile(String FilePath,STBase TheObject,boolean ShowDialogs) Exception Saves the object based on its content and the current file path and other settings. Parameters: FilePath - path to the file to save the data into TheObject - the object with the data to save ShowDialogs - true to allow dialogs to be shown, false to supress the GUI Throws: Exception