Workbook.SaveDocument(String) Method

Saves the document to a file in the Excel or text format. The file format is identified by the file extension.

You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v19.1.dll

Declaration

C#

public void SaveDocument(
    string fileName
)

VB.NET

Public Sub SaveDocument(
    fileName As String
)

Parameters

Name	Type	Description
fileName	String	Specifies the file path to save the document.

Remarks

The DocumentFormat enumeration lists the supported document formats. To export a file to PDF or HTML, use the Workbook.ExportToPdf and Workbook.ExportToHtml methods.

Use the Workbook.Options.Export property or Workbook.BeforeExport event to specify export options.

C#

// Add a reference to the DevExpress.Docs.dll assembly.
using DevExpress.Spreadsheet;
// ...

Workbook workbook = new Workbook();
// ...

// Save the modified document to a file.
workbook.SaveDocument("Document.xlsx");

VB.NET

' Add a reference to the DevExpress.Docs.dll assembly.
Imports DevExpress.Spreadsheet
' ...

Dim workbook As New Workbook()
' ...

' Save the modified document to the file.
workbook.SaveDocument("Document.xlsx")

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SaveDocument(String) method.

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-external-workbook/CS/DocServerExternalWorkbookSample/Form1.cs#L35

externalWorkbook.Worksheets[0].Import(CreateDataTable(10), false, 0, 0);
externalWorkbook.SaveDocument("ExternalDocument.xlsx");
myWorkbook.ExternalWorkbooks.Add(externalWorkbook);

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

workbook.Worksheets[1].CopyFrom(workbook2.Worksheets[0]);
workbook.SaveDocument("test3.xlsx");
Process.Start("test3.xlsx");

spreadsheet-document-api-chart-examples/CS/SpreadsheetDocServerChartAPISamples/Form1.cs#L443

tempWorkbook.Worksheets[0].CopyFrom(workbook.Worksheets.ActiveWorksheet);
tempWorkbook.SaveDocument(fileName);
Process.Start(fileName);

VB.NET

spreadsheet-document-api-external-workbook/VB/DocServerExternalWorkbookSample/Form1.vb#L29

externalWorkbook.Worksheets(0).Import(CreateDataTable(10), False, 0, 0)
externalWorkbook.SaveDocument("ExternalDocument.xlsx")
myWorkbook.ExternalWorkbooks.Add(externalWorkbook)

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

workbook.Worksheets(1).CopyFrom(workbook2.Worksheets(0))
workbook.SaveDocument("test3.xlsx")
Process.Start("test3.xlsx")

spreadsheet-document-api-chart-examples/VB/SpreadsheetDocServerChartAPISamples/Form1.vb#L424

tempWorkbook.Worksheets(0).CopyFrom(workbook.Worksheets.ActiveWorksheet)
tempWorkbook.SaveDocument(fileName)
Process.Start(fileName)

Implements

SaveDocument(String)