officefileapi-devexpress-dot-spreadsheet-dot-workbook-dot-savedocument-x28-system-dot-io-dot-stream-devexpress-dot-spreadsheet-dot-documentformat-x29.md
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.v25.2.dll
NuGet Package : DevExpress.Document.Processor
public void SaveDocument(
Stream stream,
DocumentFormat format
)
Public Sub SaveDocument(
stream As Stream,
format As DocumentFormat
)
| Name | Type | Description |
|---|---|---|
| stream | Stream |
Specifies the output stream.
| | format | DocumentFormat |
A DocumentFormat enumeration value that specifies the document’s format.
|
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.
// 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);
}
' 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
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.
The following code snippets (auto-collected from DevExpress Examples) contain references to the SaveDocument(Stream, 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.
web-dashboard-custom-info-exported-excel/CS/WebDashboardForm.aspx.cs#L51
if (e.ExcelExportOptions.Format == ExcelFormat.Xlsx)
workbook.SaveDocument(ms, DocumentFormat.Xlsx);
else if (e.ExcelExportOptions.Format == ExcelFormat.Xls)
winforms-dashboard-custom-items/CS/TutorialsCustomItems/Form1.cs#L58
e.Stream.SetLength(0);
workbook.SaveDocument(e.Stream, DocumentFormat.Xlsx);
}
office-file-api-ai-implementation/CS/BusinessObjects/Helpers.cs#L127
if (encryptionSettings == null)
workbook.SaveDocument(resultStream, documentFormat);
else
winforms-dashboard-customize-exported-document/VB/CustomExportDocumentExample/Form1.vb#L62
If e.ExcelExportOptions.Format = ExcelFormat.Xlsx Then
workbook.SaveDocument(fileStream, DocumentFormat.Xlsx)
ElseIf e.ExcelExportOptions.Format = ExcelFormat.Xls Then
web-dashboard-custom-info-exported-excel/VB/WebDashboardForm.aspx.vb#L54
If e.ExcelExportOptions.Format = ExcelFormat.Xlsx Then
workbook.SaveDocument(ms, DocumentFormat.Xlsx)
ElseIf e.ExcelExportOptions.Format = ExcelFormat.Xls Then
winforms-dashboard-custom-items/VB/TutorialsCustomItems/Form1.vb#L62
e.Stream.SetLength(0)
workbook.SaveDocument(e.Stream, DocumentFormat.Xlsx)
End If
SaveDocument(Stream, DocumentFormat)
See Also