|Number of watchers on Github||1564|
|Number of open issues||23|
|Average time to close an issue||3 months|
|Average time to merge a PR||1 day|
|Open pull requests||16+|
|Closed pull requests||20+|
|Last commit||10 months ago|
|Repo Created||over 4 years ago|
|Repo Last Updated||10 months ago|
|Organization / Author||officedev|
|Do you use Open-XML-SDK? Leave a review!|
|View open issues (23)|
|View Open-XML-SDK activity|
|View on github|
|Fresh, new opensource launches 🚀🚀🚀|
Trendy new open source projects in your inbox! View examples
The Open XML SDK provides tools for working with Office Word, Excel, and PowerPoint documents. It supports scenarios such as:
The official release NuGet packages for Open XML SDK are available on Nuget.org.
The NuGet package for the latest builds of the Open XML SDK is available as a custom feed on MyGet. You can trust this package source, since the custom feed is locked and only this project feeds into the source. Stable releases here will be mirrored onto NuGet and will be identical.
For latests changes, please see the changelog
This library supports many platforms. There are builds for .NET 3.5, .NET 4.0, .NET 4.6, and .NET Standard 1.3. The following platforms are currently supported:
There is a known issue in
WindowsBase that causes crashes when handling large data sources. This is fixed in later versions of the library, based on the platform availability of the
System.IO.Packaging package. When possible, we use this package instead of
WindowsBase. This not only fixes the crash seen by some users, but is available cross platform. However, it is only available on .NET Standard 1.3+ and .NET Framework 4.6+. For this reason, the NuGet package has multiple targets to bring in, when possible. The targets are determined by NuGet at installation and build time and are listed in the table below.
|Platform||System.IO.Packing Source||Tested by|
|.NET 4.0||WindowsBase||.NET 4.5.2|
|.NET 4.6||NuGet||.NET 4.6|
|.NET Standard||NuGet||.NET Core 1.0|
Keep in mind, though, that the
System.IO.Packaging on .NET 4.6+ is simply a facade over WindowsBase, and thus everything running on .NET 4.6 will use WindowsBase instead of the newer implementation.
The package you want to install is DocumentFormat.OpenXml.
The package feed or the package source is specified by the feed URL. Depending on your version of Visual Studio, choose the appropriate feed URL from the table below.
Table 1: The latest builds are available via a MyGet feed.
|NuGet V3 (Visual Studio 2015+)||https://dotnet.myget.org/F/open-xml-sdk/api/v3/index.json|
|NuGet V2 (Visual Studio 2012+)||https://dotnet.myget.org/F/open-xml-sdk/api/v2|
Install-Package command considers the package source either via configuration or argument. Also, the package version can vary. For the latest version info, see the feed for the DocumentFormat.OpenXml package.
PM> Install-Package DocumentFormat.OpenXml -Version <version retrieved from the web>
PM> Install-Package DocumentFormat.OpenXml -Version <version retrieved from the web> -Source https://dotnet.myget.org/F/open-xml-sdk/api/v3/index.json
Note: If you have trouble installing the package, try restarting Visual Studio. Package sources could be cached and changes you've made to any NuGet.config files may not be detected.
If you want to report a problem (bug, behavior, build, distribution, feature request, etc...) with the SDK built by this repository, please feel free to post a new issue and someone will try to help.
If you have
how-to questions please post to one of the following resources:
System.IO.PackageNuGet package (i.e. Xamarin), opening some documents will fail due to an issue in
System.IO.Packaging. For now, you must manually set the environment variable as described in UriKind.RelativeOrAbsolute workaround.
IsolatedStorageExceptionmay 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.
System.IO.Packaging on .NET Core has feature parity with
WindowsBase (i.e. streaming support), we can investigate using the new .NET Core on .NET Framework.
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 MSDN is still accurate.
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.
This project uses the csproj format and the release versions of the tooling in Visual Studio 2017. For more information on how to use this project type to build your project, see the release notes for Visual Studio 2017. Other editors that support the latest .NET project files include Visual Studio Code, Visual Studio for Mac, or .NET CLI. See .NET Downloads for details.
The project often requires the latest release of the C# compiler as many new features come on-line that greatly aid in ease of development. As of now, the C# 7.2 compiler is required (which was released in December 2017) and comes standard in Visual Studio 2017 Update 5, with other IDEs providing updates to the compiler, as well.
If you want to use a command line approach:
dotnet restorein the directory.
dotnet test DocumentFormat.OpenXml.Teststo run the tests.
dotnet pack DocumentFormat.OpenXmlto generate a nupkg.
Bug fixes, System.IO.Packaging upgrade, more...
Fixes assembly versioning and a few other issues.