Workbook.SaveDocument(String, DocumentFormat) Method

Saves the document to a file in the specified document format.

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

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v23.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public void SaveDocument(
    string fileName,
    DocumentFormat format
)

VB.NET

Public Sub SaveDocument(
    fileName As String,
    format As DocumentFormat
)

Parameters

Name	Type	Description
fileName	String	Specifies the file path to save the document.
format	DocumentFormat	A DocumentFormat enumeration value that specifies the document’s format.

Remarks

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

Calculate Formulas Before Save Operation

The default calculation mode for a Workbook is Manual. This mode implies that the Spreadsheet does not calculate formulas before it saves a document. Call the Workbook.Calculate or Workbook.CalculateFull method to calculate all formulas in the workbook.

Example

Call the Workbook.SaveDocument method with the specified file path to save a workbook to the file. Specify the file format as the second parameter of the method using the DocumentFormat enumerator.

C#

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

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

// Save the modified document to the file.
workbook.SaveDocument("Documents\\SavedDocument.xlsx", DocumentFormat.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("Documents\SavedDocument.xlsx", DocumentFormat.Xlsx)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SaveDocument(String, DocumentFormat) 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-apply-conditional-formatting-to-cell-range/CS/ConditionalFormatting_Example/Form1.cs#L80

// Save the modified document to a file.
workbook.SaveDocument("Documents\\SavedDocument.xlsx", DocumentFormat.OpenXml);
#endregion #SaveDocumentToFile

spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/Form1.cs#L209

string fileName = "SampleDocument.xlsx";
workbook.SaveDocument(fileName, DocumentFormat.Xlsx);
Process.Start(fileName);

spreadsheet-document-api-pivot-table-examples/CS/SpreadsheetDocServerPivotAPI/Form1.cs#L224

string fileName = "SampleDocument.xlsx";
workbook.SaveDocument(fileName, DocumentFormat.Xlsx);
Process.Start(fileName);

spreadsheet-document-api-use-worksheet-data-bindings-to-process-data/CS/PerformanceCounterCorrelationExample/WorksheetProcessor.cs#L23

    string fileName = String.Format("{0:yyyy-MM-ddTHH-mm-ss}{1}.xlsx", DateTime.Now, fileNameBase);
    wb.SaveDocument(fileName, DocumentFormat.Xlsx);
}

spreadsheet-document-api-examples-part1/CS/SpreadsheetExamples/Form1.cs#L138

// Save the modified document to the file.
workbook.SaveDocument("Documents\\SavedDocument.xlsx", DocumentFormat.OpenXml);
#endregion #SaveDocumentToFile

VB.NET

spreadsheet-document-api-apply-conditional-formatting-to-cell-range/VB/ConditionalFormatting_Example/Form1.vb#L71

            ' Save the modified document to a file.
            workbook.SaveDocument("Documents\SavedDocument.xlsx", DocumentFormat.OpenXml)
#End Region  ' #SaveDocumentToFile

spreadsheet-document-api-examples-part2/VB/SpreadsheetDocServerAPIPart2/Form1.vb#L180

Dim fileName As String = "SampleDocument.xlsx"
workbook.SaveDocument(fileName, DocumentFormat.Xlsx)
Call Process.Start(fileName)

spreadsheet-document-api-pivot-table-examples/VB/SpreadsheetDocServerPivotAPI/Form1.vb#L211

Dim fileName As String = "SampleDocument.xlsx"
workbook.SaveDocument(fileName, DocumentFormat.Xlsx)
Process.Start(fileName)

spreadsheet-document-api-use-worksheet-data-bindings-to-process-data/VB/PerformanceCounterCorrelationExample/WorksheetProcessor.vb#L24

    Dim fileName As String = String.Format("{0:yyyy-MM-ddTHH-mm-ss}{1}.xlsx", Date.Now, fileNameBase)
    wb.SaveDocument(fileName, DocumentFormat.Xlsx)
End Sub

spreadsheet-document-api-encryption/VB/EncryptionExample/Program.vb#L41

If IsValid = True Then
    workbook.SaveDocument(fileName, documentFormat)
    Process.Start(fileName)

Implements

SaveDocument(String, DocumentFormat)