Read and Write Open XML Files in MS Office 2007

Introduction

With Office 2007, Microsoft decided to change default application formats from the old, proprietary, closed formats (DOC, XLS, and PPT) to new, open and, standardized XML formats (DOCX, XLSX, and PPTX). New formats share some similarities with old Office XML formats (WordML, SpreadsheetML) and some similarities with competing OpenOffice.org OpenDocument formats, but there are many differences. Because new formats will be the default in Office 2007, and Microsoft Office is the most predominant office suite, these formats are destined to be popular and you will probably have to deal with them sooner or later.

This article will explain the basics of the Open XML file format and specifically the XLSX format, the new format for Excel 2007. Presented is a demo application that reads and writes tabular data to and from XLSX files. The application is written in C# using Visual Studio 2005. The XLSX files it creates can be opened using Excel 2007.

The Microsoft Open XML Format

Every Open XML file is essentially a ZIP archive containing many other files. Office-specific data is stored in multiple XML files inside that archive. This is in direct contrast with old WordML and SpreadsheetML formats that were single, non-compressed XML files. Although they are more complex, the new approach offers several benefits:

  • You don't need to process the entire file to extract specific data.
  • Images and multimedia are now encoded in native format, not as text streams.
  • Files are smaller as a result of compression and native multimedia storage.

In Microsoft's terminology, an Open XML ZIP file is called a package. Files inside that package are called parts. It is important to know that every part has a defined content type and there are no default type presumptions based on the file extension. Content type can describe anything: application XML, user XML, images, sounds, video, or any other binary objects. Every part must be connected to some other part using a relationship. Inside the package are special XML files with a ".rels" extension that defines the relationship between parts. There is also a start part (sometimes called "root," which is a bit misleading because a graph containing all parts doesn't have to be a tree structure), so the entire structure looks like Figure 1.

Figure 1: Parts and relations inside an XLSX file

To make a long story short, to read the data from an Open XML file you need to:

  1. Open the package as a ZIP archive: Any standard ZIP library will do.
  2. Find the parts that contain data you want to read: You can navigate through the relationship graph (more complex), or you can presume that certain parts have a defined name and path (Microsoft can change that in the future).
  3. Read the parts you are interested in: Use the standard XML library (if they are XML) or some other method (if they are images, sounds, or some other type).

On the other hand, if you want to create a new Open XML file, you need to:

  1. Create/get all necessary parts: Use a standard XML library (if they are XML), copy them, or use some other method.
  2. Create all relationships: Create ".rels" files.
  3. Create content types: Create a "[Content_Types].xml" file.
  4. Package everything into a ZIP file with the appropriate extension (DOCX, XLSX, or PPTX): Any standard ZIP library will do.

The whole story about packages, parts, content types, and relations is the same for all Open XML documents (regardless of whether they originate in the application). Microsoft refers to this as Open Packaging Conventions.

Excel 2007 Open XML Specifics

Excel 2007 extends on the basis of Open Packaging Conventions by adding its own application-specific XML types. Reference schemas for all XML files used in Office can be downloaded from MSDN, but note that some things are still open to change until the final Excel 2007 release.

You just want to read/write worksheet data, so you need to look in the "\xl\worksheets" folder inside the XLSX file; this is where all the worksheets are located. For every worksheet, there is a separate XML file: "sheet1.xml," "sheet2.xml," and so on. When you open such a file, you will notice that all of the sheet data is inside a <sheetData> element. For every row, there is a <row> element; for every cell, there is a <c> element. Finally, the value of the cell is stored in a <v> element.

However, real-world XML is never simple as schoolbook XML. You will notice that numbers get encoded as numbers inside the <v> element:

<c r="A1">
   <v>100</v>
</c>

However, a string value (like "John"), also gets encoded as a number:

<c r="B1" t="s">
   <v>0</v>
</c>

That is because MS Excel uses an internal table of unique strings (for performance reasons). Zero is an index of that string in an internal table of strings and attribute t="s" tells you that the underlying type is a string, not a number. So, where is the table of unique strings located? It is in an "\xl\sharedStrings.xml" XML file, and contains all the strings used in the entire workbook, not just a specific worksheet.

This approach is used for many other things: cell styles, borders, charts, number formats, and so forth. In fact, that becomes the major programming problem when working with XLSX files—updating and maintaining various tables of some unique Excel objects. In this article, you will just read/write data values, but if you require some complex formatting you probably should use some commercial component that does all the tedious work for you.

Implementation

The demo is a Windows Forms application (see Figure 2), written in C# using Visual Studio 2005. Because there is no support for ZIP files in the .NET Framework 2.0 (only for the ZIP algorithm), the demo uses an open-source ZIP library called SharpZipLib. For demonstration purposes, you will extract entire ZIP files to a TEMP folder, so you can examine the contents of that folder and its files while debugging the demo application. In a real-world application, you may want to avoid extracting to a temporary folder and just read to/write from the ZIP file directly.

For XML processing, the choice is simple. To read XML files, you use the XmlTextReader class; to write, you use the XmlTextWriter class. Both come with the .NET Framework, but you also can use any other XML processing library.

Figure 2: Demo application in action

Data Reading

You want to read a simple "In.xlsx" file (in the "Input" folder) and copy its contents to the DataTable. That file contains a list of people with their first and last names (text values) and their IDs (number values). When the "Read input .xlsx file" button is clicked, the following code is executed:

private void buttonReadInput_Click(object sender, EventArgs e)
{
   // Get the input file name from the text box.
   string fileName = this.textBoxInput.Text;

   // Delete the contents of the temporary directory.
   ExcelRW.DeleteDirectoryContents(ExcelRWForm.tempDir);

   // Unzip the input XLSX file to the temporary directory.
   ExcelRW.UnzipFile(fileName, ExcelRWForm.tempDir);

   // Open the XML file with a table of all unique strings used
   // in the workbook...
   FileStream fs = new FileStream(ExcelRWForm.tempDir
                                  + @"\xl\sharedStrings.xml",
                                  FileMode.Open, FileAccess.Read);
   // ...and call a helper method that parses that XML and returns
   // an array of strings.
   ArrayList stringTable = ExcelRW.ReadStringTable(fs);

   // Open the XML file with worksheet data...
   fs = new FileStream(ExcelRWForm.tempDir +
                       @"\xl\worksheets\sheet1.xml",
                       FileMode.Open, FileAccess.Read);
   // ...and call the helper method that parses that XML and fills
   // DataTable with values.
   ExcelRW.ReadWorksheet(fs, stringTable, this.data);
}

Nothing unusual happens here. The XLSX file is unzipped to the TEMP folder and the necessary XML parts (now files) are processed. The "sharedStrings.xml" file contains a global table of unique strings whereas the "sheet1.xml" file contains data for the first sheet. Helper methods are pretty straightforward XML reading code—you can download demo application code to examine them in more detail.

If everything is okay, after the button is clicked, all data will show up in the DataGridView.

Data Writing

Now, you want to write data from a DataTable to the "Out.xlsx" file in the "Output" folder. You can change some data or add some new rows in the DataGridView. When the "Write output .xlsx file" button is clicked, the following code is executed:

private void buttonWriteOutput_Click(object sender, EventArgs e)
{
   // Get the output file name from the text box.
   string fileName = this.textBoxOutput.Text;

   // Delete the contents of the temporary directory.
   ExcelRW.DeleteDirectoryContents(ExcelRWForm.tempDir);

   // Unzip the template XLSX file to the temporary directory.
   ExcelRW.UnzipFile(ExcelRWForm.templateFile, ExcelRWForm.tempDir);

   // You will need two string tables; a lookup Hashtable for fast
   // searching and an ordinary ArrayList where items are sorted
   // by their index.
   Hashtable lookupTable;

   // Call the helper methods that create both tables from input
   // data.
   ArrayList stringTable = ExcelRW.CreateStringTables(this.data,
      out lookupTable);

   // Create an XML file...
   FileStream fs = new FileStream(ExcelRWForm.tempDir
      + @"\xl\sharedStrings.xml", FileMode.Create);

   // ...and fill it with unique strings used in the workbook
   ExcelRW.WriteStringTable(fs, stringTable);

   // Create an XML file...
   new FileStream(ExcelRWForm.tempDir + @"\xl\worksheets\sheet1.xml",
                  FileMode.Create);

   // ..and fill it with rows and columns of the DataTable.
   ExcelRW.WriteWorksheet(fs, this.data, lookupTable);

   // ZIP the temporary directory to the XLSX file.
   ExcelRW.ZipDirectory(ExcelRWForm.tempDir, fileName);

   // If the checkbox is checked, show the XLSX file in Excel 2007.
   if (this.checkBoxOpenFile.Checked)
      System.Diagnostics.Process.Start(fileName);
}

This time, the code is a bit more complicated. So that you don't generate all necessary parts needed for XLSX file, you should decide to use a template file. You extract the template file to the temporary folder and then just change the XML parts containing a shared string table and worksheet data. All other parts, relationships, and content types stay the same, so you don't need to generate any of that. Note that you use two string tables: a lookup Hashtable for fast searching and an ordinary ArrayList where items are sorted by their index. You could pull it out only with ArrayList, but then you would need to search entire ArrayList every time you added a new string (to check whether it is already there). The CreateStringTables() helper method builds both string tables, the WriteStringTable() helper method writes the string table XML, and the WriteWorksheet() helper method writes worksheet data XML.

Again, download the demo application code to examine helper methods in more detail.

Alternative Ways

As always in programming, there is more than one method to achieve the same goal.

You could use Office automation to start an instance of Excel 2007 (or any other Office application) and then use interop calls to create a document and save it. However, using automation has some drawbacks that I have already written about (see these at http://www.gemboxsoftware.com/GBSpreadsheet.htm#Automation).

The mext version of the .NET Framework (codename WinFX) will have support for Open Packaging Conventions (package handling and navigating the relationships), but it seems there will be no support for accessing application-specific data, so you still will need to process XML parts manually.

As another option, you could use some third-party component that will come with support for the Open XML format. This will probably cost you some money but has the advantage that usually more than one format (for example, XLS, XLSX, and CSV) are supported within the same API, so your application will be able to use the same code to target different file formats.



About the Author

Zeljko Svedic

Zeljko Svedic works as a lead developer at GemBox Software. He primarily works on GemBox.Spreadsheet, a .NET component for reading and writing native XLS files.

Downloads

Comments

  • There are no comments yet. Be the first to comment!

Leave a Comment
  • Your email address will not be published. All fields are required.

Top White Papers and Webcasts

  • Live Event Date: November 20, 2014 @ 2:00 p.m. ET / 11:00 a.m. PT Are you wanting to target two or more platforms such as iOS, Android, and/or Windows? You are not alone. 90% of enterprises today are targeting two or more platforms. Attend this eSeminar to discover how mobile app developers can rely on one IDE to create applications across platforms and approaches (web, native, and/or hybrid), saving time, money, and effort and introducing apps to market faster. You'll learn the trade-offs for gaining long …

  • Live Event Date: October 29, 2014 @ 11:00 a.m. ET / 8:00 a.m. PT Are you interested in building a cognitive application using the power of IBM Watson? Need a platform that provides speed and ease for rapidly deploying this application? Join Chris Madison, Watson Solution Architect, as he walks through the process of building a Watson powered application on IBM Bluemix. Chris will talk about the new Watson Services just released on IBM bluemix, but more importantly he will do a step by step cognitive …

Most Popular Programming Stories

More for Developers

Latest Developer Headlines

RSS Feeds