Workbook.SaveDocument(Stream, DocumentFormat) Method

Saves the document to a stream in the specified 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.v21.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public void SaveDocument(
    Stream stream,
    DocumentFormat format
)

VB.NET

Public Sub SaveDocument(
    stream As Stream,
    format As DocumentFormat
)

Parameters

Name	Type	Description
stream	Stream	Specifies the output stream.
format	DocumentFormat	A DocumentFormat enumeration value that specifies the document’s format.

Remarks

Take into account the following when you save a document to a stream:

• Do not save a workbook to a stream that does not support seek operations. An exception is thrown in this case. Use the System.IO.Stream.CanSeek property to determine if the steam supports seeking.

• Do not save a workbook to the same stream from which it was loaded. In this case, document bytes are written to the end of the existing stream and an invalid document is produced.

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;
using System.IO;
// ...

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

// Save the document to a stream.
using (FileStream stream = new FileStream("Document.xlsx",
    FileMode.Create, FileAccess.ReadWrite))
{
    workbook.SaveDocument(stream, DocumentFormat.Xlsx);
}

VB.NET

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

Dim workbook As New Workbook()
' ...

' Save the document to a stream.
Using stream As New FileStream("Document.xlsx", FileMode.Create, FileAccess.ReadWrite)
    workbook.SaveDocument(stream, DocumentFormat.Xlsx)
End Using

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.

Implements

SaveDocument(Stream, DocumentFormat)