Namespace SuperOffice.IO

Classes

BinaryGenerator

Abstract class providing mechanisms supporting generating documents from binary template files.

FileSystem

Default implementation of IFileSystem. This implementation proxies all method-calls to the corresponding classes and methods in the System.IO-namespace.

Generator

Base class for generators for generating documents based on document templates. This class also contains the interface needed for instantiating a generator.

MsWordGenerator

Generator for Microsoft Word documents.

OptimizationException

Exception thrown when a value being optimized does not meet the required criteria for optimization.

ProviderStream

Stream for reading from and writing to the document archive.

SerializationReader

A SerializationReader instance is used to read stored values and objects from a byte array.

Once an instance is created, use the various methods to read the required data. The data read MUST be exactly the same type and in the same order as it was written.

SerializationWriter

A SerializationWriter instance is used to store values and objects in a byte array.

Once an instance is created, use the various methods to store the required data. ToArray() will return a byte[] containing all of the data required for deserialization. This can be stored in the SerializationInfo parameter in an ISerializable.GetObjectData() method.

As an alternative to ToArray(), if you want to apply some post-processing to the serialized bytes, such as compression, call AppendTokenTables first to ensure that the string and object token tables are appended to the stream, and then cast BaseStream to MemoryStream. You can then access the MemoryStream's internal buffer as follows:

writer.AppendTokenTables();
MemoryStream stream = (MemoryStream) writer.BaseStream;
serializedData = MiniLZO.Compress(stream.GetBuffer(), (int) stream.Length);

TagContainer

Base class for classes exposing template tags.

TemplateTagAttribute

Attribute declaring that this property is a template variable tag.

TextGenerator

Interfaces

IFastSerializationTypeSurrogate

Interface to allow helper classes to be used to serialize objects that are not directly supported by SerializationWriter/SerializationReader

IFileSystem

A wrapper-interface for file-system related operations. This interface is used internally to assist testing.

IOwnedDataSerializable

Allows a class to save/retrieve their internal data to/from an existing SerializationWriter/SerializationReader.

IOwnedDataSerializableAndRecreatable

Allows a class to specify that it can be recreated during deserialization using a default constructor and then calling DeserializeOwnedData()

IStreamProvider

Interface for the to access the archive.

Enums

BinaryGenerator.State

Enumerator containing the different states the generator can hold.

ProviderStream.AccessMode

Mode in which the is accessed.