Configuration.Save Methods
Saves the specified object and all objects that it references to a new Carmenta Engine configuration file.
Overload List
| Name | Description | |
|---|---|---|
 Public method | Save(System.String filename, EngineObject object) | Saves the specified object and all objects that it references to a new Carmenta Engine configuration file. |
| Public method | Save(System.String filename, EngineObject object, SaveMode mode) | Saves the specified object and all objects that it references to a new Carmenta Engine configuration file using the specified SaveMode. |
| Public method | Save(EngineObject object) | Saves the specified object and all objects that it references to a string that contains a Carmenta Engine configuration file. |
| Public method | Save(EngineObject object, SaveMode mode) | Saves the specified object and all objects that it references to a string that contains a Carmenta Engine configuration file using the specified SaveMode. |
| Public method | Save(System.String filename, EngineObject object, SaveMode mode, System.String defaultLanguage) | Saves the specified object and all objects that it references to a new Carmenta Engine configuration file, using the specified SaveMode and default language. |
| Public method | Save(EngineObject object, SaveMode mode, System.String defaultLanguage) | Saves the specified object and all objects that it references to a string that contains a Carmenta Engine configuration file, with the specified default language. |
Save(System.String filename, EngineObject object)
Saves the specified object and all objects that it references to a new Carmenta Engine configuration file.Syntax
public static void Save (
System.String filename,
EngineObject object
)Parameters
The path to the configuration file to write. If the file already exists, it will be overwritten.
The root of the objects hierarchy to save. This object and all other objects that it references will be saved, except for features inside a MemoryDataSet.
Remarks
Unique names will be assigned to all saved objects. If some object don't have a name, or if two or more objects have the same name, new names will be generated when the objects are saved.
The top level object will also be marked as Public in the configuration. If object is a collection, the collection itself will actually not be saved, but all the objects in the collection will be saved and marked as Public.
Save(System.String filename, EngineObject object, SaveMode mode)
Saves the specified object and all objects that it references to a new Carmenta Engine configuration file using the specified SaveMode.Syntax
public static void Save (
System.String filename,
EngineObject object,
SaveMode mode
)Parameters
The path to the configuration file to write. If the file already exists, it will be overwritten.
The root of the objects hierarchy to save. This object and all other objects that it references will be saved. This may also include feature inside a MemoryDataSet.
A SaveMode value that controls whether features inside a MemoryDataSet are also saved.
Remarks
Unique names will be assigned to all saved objects. If some object don't have a name, or if two or more objects have the same name, new names will be generated when the objects are saved.
The top level object will also be marked as Public in the configuration. If object is a collection, the collection itself will actually not be saved, but all the object in the collection will be saved and marked as Public.
Save(EngineObject object)
Saves the specified object and all objects that it references to a string that contains a Carmenta Engine configuration file.Syntax
public static System.String Save (
EngineObject object
)Parameters
The root of the objects hierarchy to save. This object and all other objects that it references will be saved, except for features inside a MemoryDataSet.
Return Value
A string that contains a Carmenta Engine configuration that represents object, or an empty string if an error occurs.
Remarks
Unique names will be assigned to all saved objects. If some object don't have a name, or if two or more objects have the same name, new names will be generated when the objects are saved.
The top level object will also be marked as Public in the configuration. If object is a collection, the collection itself will actually not be saved, but all the object in the collection will be saved and marked as Public.
Save(EngineObject object, SaveMode mode)
Saves the specified object and all objects that it references to a string that contains a Carmenta Engine configuration file using the specified SaveMode.Syntax
public static System.String Save (
EngineObject object,
SaveMode mode
)Parameters
The root of the objects hierarchy to save. This object and all other objects that it references will be saved, except for features inside a MemoryDataSet.
A SaveMode value that controls whether features inside a MemoryDataSet are also saved.
Return Value
A string that contains a Carmenta Engine configuration that represents object, or an empty string if an error occurs.
Remarks
Unique names will be assigned to all saved objects. If some object don't have a name, or if two or more objects have the same name, new names will be generated when the objects are saved.
The top level object will also be marked as Public in the configuration. If object is a collection, the collection itself will actually not be saved, but all the object in the collection will be saved and marked as Public.
Save(System.String filename, EngineObject object, SaveMode mode, System.String defaultLanguage)
Saves the specified object and all objects that it references to a new Carmenta Engine configuration file, using the specified SaveMode and default language.Syntax
public static void Save (
System.String filename,
EngineObject object,
SaveMode mode,
System.String defaultLanguage
)Parameters
The path to the configuration file to write. If the file already exists, it will be overwritten.
The root of the objects hierarchy to save. This object and all other objects that it references will be saved. This may also include feature inside a MemoryDataSet.
A SaveMode value that controls whether features inside a MemoryDataSet are also saved.
The language that properties like display names and descriptions are given in.
Remarks
Unique names will be assigned to all saved objects. If some object don't have a name, or if two or more objects have the same name, new names will be generated when the objects are saved.
Specifying a default language will not affect the output other than that the configuration will be tagged with that language as the default. If the configuration is later loaded into a new Configuration instance, the default language can be retrieved with DefaultLanguage.
The top level object will also be marked as Public in the configuration. If object is a collection, the collection itself will actually not be saved, but all the object in the collection will be saved and marked as Public.
Save(EngineObject object, SaveMode mode, System.String defaultLanguage)
Saves the specified object and all objects that it references to a string that contains a Carmenta Engine configuration file, with the specified default language.Syntax
public static System.String Save (
EngineObject object,
SaveMode mode,
System.String defaultLanguage
)Parameters
The root of the objects hierarchy to save. This object and all other objects that it references will be saved, except for features inside a MemoryDataSet.
A SaveMode value that controls whether features inside a MemoryDataSet are also saved.
The language that properties like display names and descriptions are given in.
Return Value
A string that contains a Carmenta Engine configuration that represents object, or an empty string if an error occurs.
Remarks
Unique names will be assigned to all saved objects. If some object don't have a name, or if two or more objects have the same name, new names will be generated when the objects are saved.
Specifying a default language will not affect the output other than that the configuration will be tagged with that language as the default. If the configuration is later loaded into a new Configuration instance, the default language can be retrieved with DefaultLanguage.
The top level object will also be marked as Public in the configuration. If object is a collection, the collection itself will actually not be saved, but all the object in the collection will be saved and marked as Public.
Platforms
Windows, Linux, Android