devexpress/agent-skills/devexpress-office-file-api-spreadsheet

DevExpress Spreadsheet Document API

The Spreadsheet Document API is a non-visual .NET library for creating, loading, editing, and exporting spreadsheet documents (Excel workbooks) programmatically — without requiring Microsoft Office. It supports .xlsx, .xls, .xlsm, .csv, .txt formats and can export to PDF, HTML, and images.

When to Use This Skill

Use this skill when you need to:

• Create Excel workbooks (.xlsx, .xls, .xlsm) programmatically without Microsoft Office
• Read, parse, or extract data from existing .xlsx/.xls/.csv files
• Modify existing spreadsheets (add data, change formatting, update formulas)
• Apply cell formatting (fonts, colors, borders, number formats, conditional formatting)
• Work with formulas and calculated values (SUM, VLOOKUP, IF, array formulas, UDFs)
• Create and configure charts within spreadsheets (column, line, pie, scatter, pivot, Excel 2016)
• Build pivot tables from worksheet data
• Import data from arrays, collections, DataTables, or databases
• Export spreadsheets to PDF, HTML, or images
• Print spreadsheets or configure page setup and print titles
• Protect workbooks or individual worksheets with passwords
• Work with named ranges, tables (ListObjects), data validation, sparklines

Prerequisites & Installation

NuGet Packages

.NET (8/9/10+)

dotnet add package DevExpress.Document.Processor

.NET Framework (4.6.2+)

Install-Package DevExpress.Document.Processor

See references/getting-started-dotnet-fw.md for the full framework-specific guide.

Important: All DevExpress packages in a project must share the same version number. A valid DevExpress license is required.

Package Versions

Unless the user explicitly requests a specific version, always target the latest DevExpress release (v26.1 at the time of writing). dotnet add package <PackageName> without --version installs the latest stable version — prefer this form. Never pin an older version in project files, Dockerfiles, or CI/CD pipelines unless the user asks for it. This is especially important in integration scenarios (Docker, cloud deployments). All DevExpress.* packages in a project must share the same version.

Non-Windows Development (Linux, macOS, Docker, Cloud)

On non-Windows platforms, add the Skia-based drawing engine package: dotnet add package DevExpress.Drawing.Skia (plus DevExpress.Pdf.SkiaRenderer only if the app renders PDF page content, e.g. Workbook.ExportToPdf). The SkiaSharp-based engine is enabled automatically on non-Windows platforms. Enable Settings.DrawingEngine at app startup only to force Skia on Windows (e.g., to work around the 10K GDI-handle limit).

See references/getting-started.md for the full non-Windows setup and troubleshooting guide.

Before You Start — Ask the Developer

If the host agent has a structured question-asking tool available, use it to ask these questions one at a time with clear options — for example, Claude Code's AskUserQuestion tool or GitHub Copilot's askQuestions tool. If no such tool is available, ask the questions directly in the chat response before generating code.

Before generating code, ask these questions to avoid rework:

General Questions

1. Target framework: Are you using .NET 8+ or .NET Framework 4.x?
2. New or existing project?: Creating new or adding to existing?
3. Hosting model: Console app, ASP.NET Core, Blazor, MAUI, WinForms, WPF, or something else?

Spreadsheet-Specific Questions

1. Operation type: Create new, read existing, modify, export, or convert?
2. Features needed: Formatting, formulas, charts, pivot tables, data import, mail merge, protection?
3. Output format: .xlsx, .csv, PDF, HTML, or image?

Rule: If the developer's answer is ambiguous or missing, ask before generating code. Do not guess.

Component Overview

The Spreadsheet Document API provides:

• Document management: Create, load, save, and export workbooks (Workbook, IWorkbook, DocumentFormat)
• Cell operations: Read/write values, formulas, formatting (Cell, CellRange, Worksheet)
• Data operations: Import/export, sorting, filtering, grouping, data validation (WorksheetExtensions.Import)
• Visual elements: Charts, conditional formatting, sparklines, shapes, pictures (ChartCollection, ConditionalFormattingCollection)
• Document features: Named ranges, tables (ListObjects), pivot tables, comments, hyperlinks, mail merge
• Output: PDF/HTML/image export, printing with page setup

Core Entry Point

using DevExpress.Spreadsheet;
 
// Create a new workbook
using (Workbook workbook = new Workbook())
{
    Worksheet sheet = workbook.Worksheets[0];
    sheet.Cells["A1"].Value = "Hello, DevExpress!";
    workbook.SaveDocument("output.xlsx", DocumentFormat.Xlsx);
}

Documentation & Navigation Guide

Getting Started

📄 Refer to references/getting-started.md

When you need to:

• Set up the Spreadsheet Document API for the first time (.NET 8/9/10+)
• Install NuGet packages and configure the DevExpress feed
• Create your first workbook, load an existing file, or save in different formats
• Load custom fonts at runtime using DXFontRepository (Linux, Docker, cloud)
• See a complete working example

Worksheet Operations

📄 Refer to references/worksheet-operations.md

When you need to:

• Add, remove, or rename worksheets
• Copy a worksheet within the same workbook
• Move a worksheet to a different position
• Set the active worksheet or iterate over all worksheets
• Show or hide worksheets (including VeryHidden)

Getting Started (.NET Framework)

📄 Refer to references/getting-started-dotnet-fw.md

When you need to:

• Set up the API in a .NET Framework 4.6.2+ project
• Understand which assembly DLLs are needed if not using NuGet
• Configure PDF export using Windows GDI on .NET Framework

Cell Formatting

📄 Refer to references/cell-formatting.md

When you need to:

• Apply fonts, colors, borders, and alignment to cells or ranges
• Set number formats (dates, currencies, percentages, custom)
• Use BeginUpdateFormatting/EndUpdateFormatting for batch range formatting
• Apply conditional formatting rules (data bars, color scales, icon sets)
• Merge cells or adjust row height and column width
• Apply different fonts or colors to parts of a cell value (rich text, RichTextString)

Formulas & Calculations

📄 Refer to references/formulas.md

When you need to:

• Add formulas using FormulaInvariant (portable, English-language syntax)
• Calculate workbook formulas programmatically (Workbook.Calculate)
• Work with named ranges in formulas (DefinedNames)
• Create array formulas or shared formulas
• Register user-defined functions (UDF) via Workbook.CustomFunctions
• Parse and analyze formula expression trees
• Use dynamic array functions (XLOOKUP, XMATCH, SORT, SORTBY, FILTER, UNIQUE) — v26.1+
• Assign formulas that spill results into adjacent cells (DynamicArrayFormula)

Data Import & Export

📄 Refer to references/data-import-export.md

When you need to:

• Import data from arrays, IEnumerable<T>, DataTable, or custom objects
• Export worksheet ranges to DataTable
• Work with CSV encoding, delimiters, or format-specific import options
• Handle BeforeImport/BeforeExport events for format-specific settings

Charts

📄 Refer to references/charts.md

When you need to:

• Create charts (column, line, pie, bar, scatter, area, bubble, stock, Excel 2016)
• Configure axes, legends, titles, and data labels
• Build combination (multi-type) charts
• Add charts to a dedicated chart sheet
• Style chart elements (fill, outline, font)

Pivot Tables

📄 Refer to references/pivot-tables.md

When you need to:

• Create pivot tables from worksheet data
• Configure row, column, data, and filter fields
• Apply pivot table styles or refresh data
• Sort, filter, or group pivot table items

Protection & Security

📄 Refer to references/protection.md

When you need to:

• Protect a workbook structure (prevent adding/deleting sheets)
• Protect individual worksheets and lock/unlock specific cells
• Encrypt files with a password on open
• Set write-protection or read-only recommendations
• Define password-protected ranges for specific users

PDF & Image Export

📄 Refer to references/export.md

When you need to:

• Export a workbook or worksheet to PDF with PDF/UA-2 accessibility (v26.1+)
• Configure PDF page size, margins, orientation, headers/footers
• Export to HTML or render worksheets as images
• Configure print settings (print area, page breaks, print titles)

Advanced Features

📄 Refer to references/advanced-features.md

When you need to:

• Work with tables/ListObjects (structured references, table styles)
• Add or validate data with DataValidations
• Insert sparklines, shapes, or pictures
• Add hyperlinks or comments to cells
• Perform mail merge from an object data source
• Work with named ranges (DefinedNames)
• Bind worksheet ranges to external data sources
• Sort a range by one or more columns (AutoFilter.SortState)
• Apply auto-filter criteria to a range (AutoFilter.Apply, ApplyCustomFilter, ApplyFilterCriteria)
• Group rows or columns into collapsible outlines (Rows.Group, Columns.Group)

Safe Spreadsheet Processing (v26.1+)

📄 Refer to references/safe-spreadsheet-processing.md

When you need to:

• Reject oversized or structurally abnormal workbooks before full parsing (DoS protection)
• Strip macros, OLE objects, ActiveX, external connections, and pivot caches on load
• Remove personal metadata, comments, and hidden rows/columns/sheets before sharing (GDPR, HIPAA, SOX)

Sign Excel Files (v26.1+)

⚠️ This feature requires DevExpress v26.1+. Reference to be added in a future update.

Quick Start Example

A complete example — create a formatted sales report and save as .xlsx:

using DevExpress.Spreadsheet;
using System.Drawing;
 
using (Workbook workbook = new Workbook())
{
    Worksheet sheet = workbook.Worksheets[0];
    sheet.Name = "Sales Report";
 
    workbook.BeginUpdate();
    try
    {
        // Headers
        sheet["A1"].Value = "Product";
        sheet["B1"].Value = "Q1 Sales";
        sheet["C1"].Value = "Q2 Sales";
        sheet["D1"].Value = "Total";
 
        // Format header row
        CellRange headers = sheet.Range["A1:D1"];
        headers.Font.Bold = true;
        headers.Font.Color = Color.White;
        headers.FillColor = Color.FromArgb(68, 114, 196);
        headers.Alignment.Horizontal = SpreadsheetHorizontalAlignment.Center;
 
        // Data rows
        sheet["A2"].Value = "Widget A";
        sheet["B2"].Value = 15000;
        sheet["C2"].Value = 18500;
        sheet["D2"].FormulaInvariant = "=B2+C2";
 
        sheet["A3"].Value = "Widget B";
        sheet["B3"].Value = 22000;
        sheet["C3"].Value = 19800;
        sheet["D3"].FormulaInvariant = "=B3+C3";
 
        // Totals row
        sheet["A4"].Value = "Totals";
        sheet["A4"].Font.Bold = true;
        sheet["B4"].FormulaInvariant = "=SUM(B2:B3)";
        sheet["C4"].FormulaInvariant = "=SUM(C2:C3)";
        sheet["D4"].FormulaInvariant = "=SUM(D2:D3)";
 
        // Number format for currency columns
        sheet.Range["B2:D4"].NumberFormat = "$#,##0";