-
Notifications
You must be signed in to change notification settings - Fork 0
Home
This project provides a number of extensions to:
- the Open XML SDK 2.5 developed by Microsoft and now maintained by Eric White (see https://github.com/OfficeDev/Open-XML-SDK) and
- the PowerTools for Open XML developed by Eric White (see http://powertools.codeplex.com).
Currently, this project consists of the following solutions:
- OpenXmlExtensions: OpenXmlMemoryStreams, OpenXmlTransforms, FlatOpcPackages, and miscellaneous extensions for Open XML Documents; and
- OpenXmlPowerTools: Proposed enhancements of Eric White's PowerTools for Open XML.
MemoryStreams are the preferred way to keep Open XML Packages, e.g., WordprocessingDocument instances, in memory for various changes or transformations performed on them. As part of the DocumentFormat.OpenXml.IO project, this solution provides a number of classes derived from MemoryStream that contain a number of useful additional features for working with Open XML Documents. All of them provide a certain level of "type safety", much like their corresponding Open XML SDK classes.
- OpenXmlMemoryStream: Abstract base class derived from MemoryStream. Corresponds to OpenXmlPackage. Includes Save and SaveAs methods, among other things, for saving an OpenXmlMemoryStream to a file.
- WordprocessingMemoryStream: Derived from OpenXmlMemoryStream, this class is the companion for WordprocessingDocuments. It includes constructors for creating WordprocessingMemoryStreams from byte arrays, files, and streams. It further includes a static method for creating a "minimum" WordprocessingDocument as a starting point for document generation. Lastly, it includes methods for opening a WordprocessingDocument from the stream.
- SpreadsheetMemoryStream: Derived from OpenXmlMemoryStream, this is the companion for SpreadsheetDocuments and provides the same general features as WordprocessingMemoryStream.
- PresentationMemoryStream: Derived from OpenXmlMemoryStream, this is the companion for PresentationDocuments and provides the same general features as WordprocessingMemoryStream and SpreadsheetMemoryStream.
Functional transforms are an interesting way to implement XML-based features. The OpenXmlTransform class and its subclasses contained in the DocumentFormat.OpenXml.Transforms namespace provide a framework for implementing such transforms:
- OpenXmlTransform: Abstract base class currently defining methods for transforming Flat OPC strings, Flat OPC XDocuments, and WordprocessingDocuments (SpreadsheetDocuments and PresentationDocuments to follow).
- FlatOpcStringTransform: Abstract base class that is subclassed by concrete transforms implementing a string-based transform. This class provides translators which translate other supported inputs, i.e., XDocument and WordprocessingDocument (at this time) into a string and the string transformed by string Transform(string) back into the original format.
- FlatOpcDocumentTransform: Abstract base class that is subclassed by concrete transforms implementing an XDocument-based transform. Like FlatOpcString transform, this class also translates between formats.
- WordprocessingDocumentTransform: Abstract base class that is subclassed by concrete transforms implementing a WordprocessingDocument-based transform. Again, the class translates between formats.
- XslOpenXmlTransform: This class is derived from FlatOpcStringTransform and uses an XSL stylesheet to perform the actual transform.
Using the framework, you can basically write transforms the way you like. Are you a Linq-to-XML person? Derive from FlatOpcDocumentTransform and implement
- XDocument Transform(XDocument)
while callers might use
- string Transform(string) or
- WordprocessingDocument Transform(WordprocessingDocument)
without really caring about which API you used to implement the actual transform. Do you want to leverage your XSL stylsheets? Go ahead and use XslOpenXmlTransform. You're the Open XML SDK programmer? Go ahead and derive from WordprocessingDocumentTransform and use the strongly typed API.
Things I'll add next will include support for the other kinds of OpenXml packages and complex transforms (e.g., chains or pipelines).
This namespace contains one class for each Open XML SDK class for which I've implemented various extensions to make my life a little easier.
This namespace contains an exploratory prototype of the FlatOpcPackage class, a subclass of System.IO.Packaging.Package that can be used in conjunction with WordprocessingDocument and its siblings to store documents in Flat OPC format right away. It uses the FlatOpcPackagePart and FlatOpcPackagePartStream classes to do its job.
This solution contains Eric White's PowerTools for Open XML (see http://powertools.codeplex.com) release 2.7.04 with some proposed fixes. The objective is to have these included in future releases of the PowerTools for Open XML.
The solution contains two static utility classes related to the OpenXmlMemoryStream classes described above:
- PtMemoryStreamExtensions: Provides extension methods for creating OpenXmlPowerToolsDocument, WmlDocument, SmlDocument, and PmlDocument instances from the corresponding OpenXmlMemoryStreams.
- PtMemoryStreamFactory: Provides static factory methods for creating a WordprocessingMemoryStream, SpreadsheetMemoryStream, and PresentationMemoryStream from a WmlDocument, SmlDocument, and PmlDocument, respectively.