Workbook Class

A non-visual component providing complete spreadsheet functionality.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v17.2.dll

Declaration

C#

public class Workbook :
    IWorkbook,
    ISpreadsheetComponent,
    IBatchUpdateable,
    IServiceContainer,
    IServiceProvider,
    IPrintable,
    IBasePrintable,
    ExternalWorkbook,
    ISupportsContentChanged,
    IDisposable

VB.NET

Public Class Workbook
    Implements IWorkbook,
               ISpreadsheetComponent,
               IBatchUpdateable,
               IServiceContainer,
               IServiceProvider,
               IPrintable,
               IBasePrintable,
               ExternalWorkbook,
               ISupportsContentChanged,
               IDisposable

Related API Members

The following members accept/return Workbook objects:

• WorkbookExtensions.Clone(IWorkbook)
• WorkbookExtensions.Clone(IWorkbook, Boolean)

Remarks

A Workbook class specifies the root object of the non-visual spreadsheet engine. It provides a comprehensive set of properties and methods required to create, load, modify, print and save the corresponding workbook without user interaction.

Use of these methods in production code requires a license to the DevExpress Document Server or the DevExpress Universal Subscription.

Please refer to the DevExpress Subscription page for pricing information.

For details, see the Workbook topic and the Examples section.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Workbook class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

spreadsheet-document-api-examples-part1/CS/SpreadsheetExamples/SpreadsheetActions/RowAndColumnActions.cs#L8

#region Actions
public static Action<Workbook> InsertRowsColumnsAction = InsertRowsColumns;
public static Action<Workbook> DeleteRowsColumnsAction = DeleteRowsColumns;

spreadsheet-chart-api-examples-t132724/CS/SpreadsheetDocServerChartAPISamples/CodeExamples/SparklineActions.cs#L9

{
    static void CreateSparklineGroups(Workbook workbook)
    {

spreadsheet-document-api-examples-part-2-t217615/CS/SpreadsheetDocServerAPIPart2/CodeExamples/GroupAndOutlineActions.cs#L8

{
    static void GroupRows(Workbook workbook)
    {

how-to-update-external-references-in-the-loaded-workbook-t177074/CS/ExternalReferencesLoadSample/Form1.cs#L18

// Alternatively, you can create another SpreadsheetControl and use its Document property.
Workbook myWorkbook;
static string shortName = "Workbook1.xlsx";

Reporting_how-to-export-reports-to-different-sheets-in-an-xlsx-file-by-using-spreadsheet-e4892/CS/WindowsFormsApplication1/Form1.cs#L37

Workbook workbook = new DevExpress.Spreadsheet.Workbook();
workbook.LoadDocument("test1.xlsx");

VB.NET

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/RowAndColumnActions.vb#L12

#Region "Actions"
Public Shared InsertRowsColumnsAction As Action(Of Workbook) = AddressOf InsertRowsColumns
Public Shared DeleteRowsColumnsAction As Action(Of Workbook) = AddressOf DeleteRowsColumns

spreadsheet-chart-api-examples-t132724/VB/SpreadsheetDocServerChartAPISamples/CodeExamples/SparklineActions.vb#L9

End Sub
Private Shared Sub CreateSparklineGroups(ByVal workbook As Workbook)
    '            #Region "#CreateSparklineGroups"

spreadsheet-document-api-examples-part-2-t217615/VB/SpreadsheetDocServerAPIPart2/CodeExamples/GroupAndOutlineActions.vb#L10

        Private Shared Sub GroupRows(ByVal workbook As Workbook)
'            #Region "#GroupRows    "

how-to-update-external-references-in-the-loaded-workbook-t177074/VB/ExternalReferencesLoadSample/Form1.vb#L18

' Alternatively, you can create another SpreadsheetControl and use its Document property.
Private myWorkbook As Workbook
Private Shared shortName As String = "Workbook1.xlsx"

Reporting_how-to-export-reports-to-different-sheets-in-an-xlsx-file-by-using-spreadsheet-e4892/VB/WindowsFormsApplication1/Form1.vb#L39

Dim workbook As Workbook = New DevExpress.Spreadsheet.Workbook()
workbook.LoadDocument("test1.xlsx")

Inheritance

Object

Workbook

Extension Methods

Clone()

Clone(Boolean)

Merge(WorkbookMergeOptions, IWorkbook[])