Use NuGet Packages to Install Office File API Components

• Feb 09, 2024
• 4 minutes to read

This topic describes how to obtain and install NuGet packages that contain Office File API products for .NET Framework, .NET Core, and .NET 6.

Available Packages

Package	Description
DevExpress.Document.Processor	Includes all Office File API products. You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this package in production code.
DevExpress.Drawing	Contains cross-platform counterparts of the System.Drawing classes not supported in non-Windows environments.
DevExpress.Drawing.Skia	Contains the cross-platform drawing functionality based on the Skia Graphics Library.
DevExpress.RichEdit.Core	Contains the runtime assemblies for the Word Processing Document API.
DevExpress.Printing.Core	Includes the Excel Export Library.

Obtain Your NuGet Feed URL

Visit nuget.devexpress.com, log in to your account, and click Obtain Feed URL. Use the generated URL or authorization key to install DevExpress NuGet packages from Visual Studio, .NET CLI, or NuGet CLI.

Refer to the following help topic for more information: Obtain Your NuGet Feed Credentials.

Install Packages in Visual Studio

Register DevExpress NuGet Feed

You need to register the DevExpress NuGet feed as a package source to access DevExpress NuGet packages. Click Tools → Options to invoke the Options dialog in Visual Studio and select NuGet Package Manager | Package Sources. You can add the DevExpress feed to the package source list in one of the following ways:

Method 1: Use an Authorization Key

You can use a feed authorization key to install DevExpress NuGet packages. In this case, specify https://nuget.devexpress.com/api as the package source.

Method 2: Use a NuGet Feed URL

Specify your NuGet Feed URL as the package source, as shown below.

Install DevExpress Packages

After you register the DevExpress NuGet feed, use the NuGet Package Manager to install DevExpress packages. In the Solution Explorer, right-click the project and select Manage NuGet Packages.

If you registered the DevExpress NuGet feed with an authorization key, the login form is displayed when you invoke the NuGet Package Manager for the first time. Enter your credentials as follows:

• User name: DevExpress
• Password: your authorization key

Select the DevExpress NuGet feed as the package source and install the DevExpress.Document.Processor package.

Note

The DevExpress.RichEdit.Core and DevExpress.Printing.Core packages are not available in the NuGet Package Manager when you use the DevExpress NuGet feed as a package source. However, you can install these packages from the DevExpress Local source, Package Manager Console, .NET CLI, or NuGet CLI.

DevExpress Local Source

If you use the Unified Component Installer to install DevExpress components, you can obtain the Office File API packages from the DevExpress 23.2 Local package source. The DevExpress installer copies all NuGet packages to the C:\Program Files\DevExpress 23.2\Components\System\Components\packages directory and creates a local NuGet feed within Visual Studio.

Package Manager Console

You can also use the Package Manager Console to install the Office File API packages. Click Tools → NuGet Package Manager → Package Manager Console to open the console. Select the DevExpress NuGet feed in the Package source drop-down list and run the Install-Package command.

CLI

# Add DevExpress.Document.Processor to your project
PM> Install-Package DevExpress.Document.Processor -Version 23.2.5

Install Packages with .NET CLI

Use the dotnet add package command to install the Office File API packages from the .NET command-line interface. You can use a feed authorization key or NuGet feed URL to access DevExpress NuGet packages.

Use an Authorization Key

If you use a feed authorization key, specify the following credentials to install DevExpress packages:

• Username: use the -u option and specify DevExpress as the option value.
• Password: use the -p option and specify your feed authorization key as the option value.

CLI

# Specify the DevExpress NuGet feed as the package source
dotnet nuget add source https://nuget.devexpress.com/api -n DXFeed -u DevExpress -p {your-feed-authorization-key}

# Add DevExpress.Document.Processor to your project
dotnet add ProjectName.csproj package DevExpress.Document.Processor -v 23.2.5

Non-Windows operating systems do not support password encryption. Use the --store-password-in-clear-text option to store credentials as plain text on these systems.

CLI

# Specify the DevExpress NuGet feed as the package source
dotnet nuget add source https://nuget.devexpress.com/api -n DXFeed -u DevExpress -p {your-feed-authorization-key} --store-password-in-clear-text

Use a NuGet Feed URL

CLI

# Add DevExpress.Document.Processor to your project
dotnet add ProjectName.csproj package DevExpress.Document.Processor -v 23.2.5 -s https://nuget.devexpress.com/{your-feed-authorization-key}/api -s https://api.nuget.org/v3/index.json

Install Packages with NuGet CLI

Use the install command to install the Office File API packages from the NuGet command-line interface. You can use a feed authorization key or NuGet feed URL to access DevExpress NuGet packages.

Use an Authorization Key

If you use a feed authorization key to install DevExpress packages, specify the following credentials to complete the installation:

• Username: DevExpress
• Password: your authorization key

CLI

nuget install DevExpress.Document.Processor -Source https://nuget.devexpress.com/api -Source https://api.nuget.org/v3/index.json
# Installation log...
Please provide credentials for: https://nuget.devexpress.com/api
UserName: DevExpress
Password: {your-feed-authorization-key}

Use a NuGet Feed URL

CLI

# Use your NuGet feed URL to install DevExpress.Document.Processor
nuget install DevExpress.Document.Processor -Source https://nuget.devexpress.com/{your-feed-authorization-key}/api -Source https://api.nuget.org/v3/index.json