[This is preliminary documentation and is subject to change.]
Serialises a tree of objects to a new file, filtered using an
optional delegate.
Declaration Syntax| C# |
public static void Serialise( Persistent root, string filePath, SerialiserFilter filter )
Parameters- root (Persistent)
- The root of the tree to serialise.
- filePath (String)
- The path and name of the file to create.
- filter (SerialiserFilter)
- A SerialiserFilter which will be called for every node being serialised. May be null. This is called for each contained node during the first serialisation pass, and during the second pass for each contained node and then each association within contained nodes which pass the filter.
Remarks This stores all objects in the tree under the root object to
a file. The tree can be already persisted, or can be provisional. It also
stores associated collection contents. Once stored, the tree can be
reproduced exactly using the TreeDeserialiser class. The
serialisation process descends the tree twice, once for contained nodes and
a second time for associations. Any associations which are not to objects
within the serialised tree are serialised as MetaReferences.