Sofu Documentation
SofuObject Class
NamespacesSofu.SofuSofuObject
Base class for all Sofu Objects (List, Map, Value, Reference and Undefined). Just a SofuObject should never occour.
Declaration Syntax
C#
public class SofuObject
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
SofuObject()()()
Creates a new empty SofuObject. Don't use this.

AppendComment(String)
Appends to the comment of this SofuObject

AsList()()()
Tries to convert itself to a Sofu.List.

AsMap()()()
Tries to convert itself to a Sofu.Map.

AsReference()()()
Seldom used, this allows to access the reference itself, while AsMap, AsList and AsValue access the referenced Object.

AsValue()()()
Tries to convert itself to a Sofu.Value

Binarify(String, Stream)
Writes this Object into a Stream, does no Cross Reference checking.

Binary(String, Stream)
Writes this Object into a Stream, does Cross Reference checking.

BinaryPack(Stream)
Starts the binary packing, boxes every other SofuObject into a Map

Clear(SofuObject, String)
Clears the reference cache and sets the root

Clear()()()
Clears the reference cache.

Equals(Object) (Inherited from Object.)
Escape(String)
Escapes a Value

Finalize()()() (Inherited from Object.)
GenID(SofuObject)
Generates one unique id.

GetComment()()()
Accesses the comment of this SofuObject.

GetHashCode()()() (Inherited from Object.)
GetType()()() (Inherited from Object.)
HasComment()()()
Tests if this SofuObject has a comment.

Indent
String used for indentation during Write();

Indentation(Int32)
Returns the indentationstring times the level.

IsDefined()()()
Tests if this SofuObject is anything else than a Sofu.Sofu.Undefined

IsList()()()
Tests if this SofuObject is a Sofu.List

IsMap()()()
Tests if this SofuObject is a Sofu.Map

IsReference()()()
Tests if this SofuObject is a Sofu.Reference

IsValue()()()
Tests if this SofuObject is a Sofu.Value

KeyEscape(String)
Returns the escape form of "key"

KeyUnescape(String)
Returns the unescape form of "key"

MemberwiseClone()()() (Inherited from Object.)
normalEscape
Switches normalEscape to complete escape, which escapes every char that is \W

Pack()()()
Packs this SofuObject and all those it contains into a string.

PackComment(Stream)
Writes the comments of this Object into a Stream

PackHeader(Stream)
Creates the Header of a binary sofu file into a stream

PackLong(UInt32, Stream)
Packs one unsigned Integer into the output stream

PackLong(Int32, Stream)
Packs one unsigned Integer into the output stream

PackText(String, Stream)
Writes a text into an output stream

SetComment(String)
Sets a comment for this SofuObject.

String(String, StringBuilder)
Identifies cross references and calls Stringify with its parameters

String(String, TextWriter, Int32)
Identifies cross references and calls Stringify with its parameters

Stringify(String, StringBuilder)
Packs this SofuObject into a string

Stringify(String, TextWriter, Int32)
Packs this SofuObject into a string

StringML(XmlWriter)
Writes this Object into Xml, does Cross Reference checking.

ToString()()() (Inherited from Object.)
TypeString()()()
Returns the type of this SofuObject. Overwritten by all its inheriting classes.

Write(TextWriter)
Writes the contents of this SofuObject into a TextWriter

Write(String)
Write this SofuObject into a file. Uses the default encoding of UTF-16.

Write(String, Encoding)
Write this SofuObject into a file.

WriteBinary(Stream, Int32, Endianness)
Writes this SofuObject and all its children into a binary sofu file

WriteBinary(Stream, Encoding, Endianness)
Writes this SofuObject and all its children into a binary sofu file

WriteBinary(Stream, Encoding)
Writes this SofuObject and all its children into a binary sofu file

WriteBinary(Stream, Int32)
Writes this SofuObject and all its children into a binary sofu file

WriteBinary(Stream, Endianness)
Writes this SofuObject and all its children into a binary sofu file

WriteBinary(Stream)
Writes this SofuObject and all its children into a binary sofu file

WriteBinary(String, Int32, Endianness)
Writes this SofuObject and all its children into a binary sofu file

WriteBinary(String, Encoding, Endianness)
Writes this SofuObject and all its children into a binary sofu file

WriteBinary(String, Encoding)
Writes this SofuObject and all its children into a binary sofu file

WriteBinary(String, Int32)
Writes this SofuObject and all its children into a binary sofu file

WriteBinary(String, Endianness)
Writes this SofuObject and all its children into a binary sofu file

WriteBinary(String)
Writes this SofuObject and all its children into a binary sofu file

WriteML(String)
Writes this Object into a SofuML file

WriteML(XmlWriter)
Writes this Object into a SofuML tree.

XMLcomment(XmlWriter)
Writes this Objects comments to XML

Xmlify(XmlWriter)
Write this SofuObject into an XmlWriter.

Inheritance Hierarchy

Assembly: Sofu (Module: Sofu) Version: 0.2.1.0 (0.2.1.0)