gerhobbelt / open-xml-sdk

Open XML SDK by Microsoft

Open XML SDK

NOTICE:

v3.0.0 beta 3 refactors and addresses some technical debt, with the goal to retain (as much as possible) source compatibility. We hope to maintain things such that you can update your package and recompile with limited changes. However, binary compatibility is not a goal and will break that for some changes which we plan on keeping documented. PRs that introduce such changes are marked with a breaking-change label and are added to a list to help migrating to v3.0.0.

Please see the v3.0.0 milestone for issues and PRs that are included. For discussions, please join us at this issue.

The Open XML SDK provides tools for working with Office Word, Excel, and PowerPoint documents. It supports scenarios such as:

• High-performance generation of word-processing documents, spreadsheets, and presentations.
• Document modification, such as adding, updating, and removing content and metadata.
• Search and replace content using regular expressions.
• Splitting up (shredding) a file into multiple files, and combining multiple files into a single file.
• Updating cached data and embedded spreadsheets for charts in Word/PowerPoint.

Table of Contents

• Packages
  • Daily Builds
  • Framework Support
• If You Have Problems
• Known Issues
• Documentation
• Related tools

Packages

The official release NuGet packages for Open XML SDK are on NuGet.org:

Package	Download
DocumentFormat.OpenXml
DocumentFormat.OpenXml.Linq
DocumentFormat.OpenXml.Features

Daily Builds

The NuGet package for the latest builds of the Open XML SDK is available as a custom feed on an Azure blob. Stable releases here will be mirrored onto NuGet and will be identical. You must set up a NuGet.config file that looks similar to this:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="OpenXmlCI" value="https://openxmlsdk.blob.core.windows.net/feed/index.json" />
  </packageSources>
</configuration>

For latests changes, please see the changelog

Framework Support

The package currently supports the following targets:

• .NET Framework 3.5, 4.0, 4.6
• .NET Standard 2.0
• .NET 6.0

For details on platform support, including other runtimes such as Mono and Unity, please see the docs at https://docs.microsoft.com/en-us/dotnet/standard/net-standard.

• Microsoft Q&A Forums (tag: office-addins-dev)
• Stack Overflow (tags: openxml or openxml-sdk)

Known Issues

• On .NET Core and .NET 5, zip packages do not have a way to stream data. Thus, the working set can explode in certain situations. This is a known issue.
• On .NET Core, targeting .NET Framework 4.5+, and .NET 5, System.Uri will not parse invalid links. This causes an exception. A workaround in v2.12.0+ of OpenXml SDK is to use OpenSettings.RelationshipErrorRewriter to rewrite them to something that can be parsed. A discussion is available here to enable something more robust in System.IO.Packaging.
• On .NET Framework, an IsolatedStorageException may be thrown under certain circumstances. This generally occurs when manipulating a large document in an environment with an AppDomain that does not have enough evidence. A sample with a workaround is available here.

Documentation

The functionality of the specific classes in this version of the Open XML SDK is similar to version 2.5, therefore the Open XML SDK 2.5 for Office documentation available on Microsoft Learn still applies.

In addition to open sourcing of the SDK, Microsoft has opened up the conceptual documentation for public review / contributions. A copy of the documentation is available for you to edit and review in GitHub.

Related tools

• Open XML SDK 2.5 Productivity Tool: The Productivity Tool provides viewing and code generation compatible with the Open XML SDK 2.5.
• Open XML Powertools: This provides example code and guidance for implementing a wide range of Open XML scenarios.
• ClosedXml: This library provides a simplified object model on top of the OpenXml SDK for manipulating and creating Excel documents.
• OfficeIMO: This library provides a simplified object model on top of the OpenXml SDK manipulating and creating Word documents.
• Serialize.OpenXml.CodeGen: This is a tool that converts an OpenXml document into the .NET code required to create it.
• Html2OpenXml: This is a tool that takes HTML and converts it to an OpenXml document.
• DocxToSource: This is a tool designed to be a replacement for the old OpenXML SDK Productivity Tool.
• OOXML Viewer: This is an extension for Visual Studio Code to View and Edit the xml parts of an Office Open XML file and to view a diff with the previous version of an OOXML part when saved from an outside program. Search "OOXML" in the VS Code extensions tab or download it from the VS Code Marketplace
• ShapeCrawler: This library provides a simplified object model on top of the OpenXml SDK to manipulate PowerPoint documents.
• OOXML Validator: VS Code extension to validate Office Open XML files. Search "OOXML" in the VS Code extensions tab or download it from the VS Code Marketplace

How can I contribute?

We welcome contributions! Many people all over the world have helped make this project better.

• Contributing explains what kinds of contributions we welcome

Reporting security issues and security bugs

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) [email protected]. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

.NET Foundation

The Open XML SDK is a .NET Foundation project.

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information, see the .NET Foundation Code of Conduct.

License

The Open XML SDK is licensed under the MIT license.