Notes2Self.net

OpenXML code snippets

I just spotted a great post on the TechEd Bloggers feed from Erika Ehrli - "Open XML File Formats: What is it, and how can I get started?"

Erika points out some interesting resources for thise wanting to learn more about the Open XML File Formats:

• Introducing the Microsoft Office (2007) Open XML File Formats:  Learn the benefits of the Microsoft Office (2007) Open XML Formats. Users can exchange data between Office applications and enterprise systems using XML and ZIP technologies. Documents are universally accessible. And, you reduce the risk of damaged files.
• Walkthrough: Word 2007 XML Format: I wrote this article to provide a deep dive to the Word 2007 XML Format architecture, key components, and ways in which you can programmatically modify content.
• Setting Word Document Properties the Office 2007 Way: Ken Getz wrote this great MSDN Magazine article on how to extract document properties using the Open XML File Formats.
• Open XML File Format Code Snippets for Visual Studio 2005: Kevin Boske and Ken Getz have been working together for months to create a set of code samples in C# and VB.NET (Visual Studio 2005 Code Snippets) that will help you to accomplish the following tasks:

Open XML Snippets

• Open XML: Get OfficeDocument Part: Given an Open XML file, retrieve the part with the http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument relationship type.

Microsoft Office Excel Snippets

• Excel: Add Custom UI: This snippet adds a custom UI Ribbon part to a given workbook.
• Excel: Delete Comments by a specific User: This snippet deletes all comments from a given user from a given workbook.
• Excel: Delete Worksheet: This snippet deletes the specified worksheet from within a given workbook and resets the selected worksheet to the next one on the list. Returns true if successful, false if failure.
• Excel: Delete Excel 4.0 Macro sheets: This snippet deletes all the Excel 4.0 Macro (XLM) sheets from a given workbook.
• Excel: Retrieve hidden rows or columns: This snippet returns a list of hidden row numbers or column names from a given workbook and worksheet.
• Excel: Export Chart: Given a workbook and title of a chart, this snippet exports the chart as a Chart (.crtx) file.
• Excel: Get Cell Value: Given a workbook, worksheet and cell address, this snippet returns the value of the cell as a string.
• Excel: Get Comments as XML: Given a workbook, this snippet returns all the comments as an XmlDocument.
• Excel: Get Hidden Worksheets: This snippet returns a list containing the name and type of all hidden sheets in a given workbook.
• Excel: Get Worksheet Information: This snippet returns a list containing the name and type of all sheets in a given workbook.
• Excel: Get Cell for Reading: Given a workbook, worksheet and cell address, this snippet demonstrates how to navigate to the cell to retrieve its contents. The cell must exist for the function to find it.
• Excel: Get Cell for Writing: Given a workbook, worksheet and cell address, this snippet demonstrates how to navigate to the cell to set its value. If the cell does not exist, the snippet creates it.
• Excel: Insert Custom XML: Given a workbook and a custom XML value, this snippet inserts the custom XML into the workbook.
• Excel: Insert Header or Footer: Given a workbook, worksheet and text to insert and a header or footer type, this snippet inserts the header or footer with the given text into the worksheet.
• Excel: Insert a Numeric Value into a Cell: Given a workbook, worksheet, cell address and numeric value, this snippet inserts the value into the cell.
• Excel: Insert a String Value into a Cell: Given a workbook, worksheet, cell address and string value, this snippet inserts the value into the cell.
• Excel: Set Recalc Option: Given a workbook and a RecalcOption, this snippet sets the recalculation property to the new option.

Microsoft Office PowerPoint Snippets

• PowerPoint: Delete Comments by User: Given a presentation and a user name, this snippet deletes all comments by that user.
• PowerPoint: Delete Slide by Title: Given a presentation and slide title, this snippet deletes the first instance of a slide with that title (titles are not unique).
• PowerPoint: Get Slide Count: This snippet returns the number of slides in a given presentation.
• PowerPoint: Get Slide Titles: Given a presentation, this snippet returns a list of the slide titles in the order presented.
• PowerPoint: Modify Slide Title: Given a presentation, old slide title, and new slide title, this snippet changes the first instance of a slide with the given title to the new value. The snippet returns true if successful, false if not successful.
• PowerPoint: Reorder Slides: Given a presentation, an original position, and a new position, attempt to place the slide from the original position into the new position within the deck. If the original position is outside the range of the number of slides in the deck, use the last slide. If the new position is outside the range of slides in the deck, put the selected slide at the end of the deck. The snippet returns the loctation wher the slide was placed, or -1 on failure.
• PowerPoint: Replace Image: Given a presentation, slide title and image file, this snippet replaces the first image on the slide with the given image.
• PowerPoint: Retrieve Slide Location by Title: Given a presentation and a slide title, this snippet returns the 0-based location of the first slide with a matching title.

Microsoft Office Word Snippets

• Word: Accept Revisions: Given a document and an author name, this snippet accepts the revisions by that author.
• Word: Add Header: Given a document and a stream containing valid header content, add the stream content as a header in the document.
• Word: Convert DOCM to DOCX: Given a macro-enabled document (.docm), this snippet removes the VBA project and converts the file to a macro-free Word Document (.docx).
• Word: Remove Comments: Given a Word Document, this snippet removes all the comments.
• Word: Remove Headers and Footers: This snippet removes all headers and footers from a given Word document.
• Word: Remove Hidden Text: This snippet removes any hidden text in a given document.
• Word: Replace Style: Given a document and valid header content, this snippet adds the content as a header in the document.
• Word: Retrieve Application Property: Given a document name and an app property, this snippet returns the value of the property.
• Word: Retrieve Core Property: Given a document name and a core property, this snippet returns the value of the property.
• Word: Retrieve Custom Property: Given a document name and a custom property, this snippet returns the value of the property.
• Word: Retrieve Table of Contents: Given a document name, this snippet returns a table of contents as an XmlDocument.
• Word: Set Application Property: This snippet sets a property’s value given a document name, application property and value. The snippet returns the old value if successful.
• Word: Set Core Property: Given a document name, a core property, and property value, this snippet sets the property value.
• Word: Set Custom Property: Given a document name, a custom property, and a value, this snippet sets the property’s value. If the property does not exist, create it. Returns true if successful, false if not.
• Word: Set Print Orientation: Given a document name, this snippet sets the print orientation for all sections in the document.

Download them here!