officefileapi-devexpress-dot-spreadsheet-dot-workbook-dot-savedocument-x28-system-dot-io-dot-stream-devexpress-dot-spreadsheet-dot-documentformat-devexpress-dot-spreadsheet-dot-encryptionsettings-x29.md
Saves the document to a stream in the specified format and with the specified encryption settings.
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,
EncryptionSettings encryptionSettings
)
Public Sub SaveDocument(
stream As Stream,
format As DocumentFormat,
encryptionSettings As EncryptionSettings
)
| Name | Type | Description |
|---|---|---|
| stream | Stream |
Specifies the output stream.
| | format | DocumentFormat |
A DocumentFormat enumeration value that specifies the document’s format.
| | encryptionSettings | EncryptionSettings |
Specifies encryption options.
|
Use this SaveDocument method overload to encrypt a workbook with a password, as shown below:
// Add a reference to the DevExpress.Docs.dll assembly.
using DevExpress.Spreadsheet;
using System.IO;
// ...
Workbook workbook = new Workbook();
// ...
// Specify encryption settings.
EncryptionSettings encryptionSettings = new EncryptionSettings();
encryptionSettings.Type = DevExpress.Spreadsheet.EncryptionType.Strong;
encryptionSettings.Password = "password";
// Save the document.
using (FileStream stream = new FileStream("Document.xlsx",
FileMode.Create, FileAccess.ReadWrite))
{
workbook.SaveDocument(stream, DocumentFormat.Xlsx, encryptionSettings);
}
' Add a reference to the DevExpress.Docs.dll assembly.
Imports DevExpress.Spreadsheet
Imports System.IO
' ...
Dim workbook As New Workbook()
' ...
' Specify encryption settings.
Dim encryptionSettings As New EncryptionSettings()
encryptionSettings.Type = DevExpress.Spreadsheet.EncryptionType.Strong
encryptionSettings.Password = "password"
' Save the document.
Using stream As New FileStream("Document.xlsx", FileMode.Create, FileAccess.ReadWrite)
workbook.SaveDocument(stream, DocumentFormat.Xlsx, encryptionSettings)
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, EncryptionSettings) 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.
office-file-api-in-web-api-app/CS/BusinessObjects/Helpers.cs#L192
SpreadsheetDocumentFormat documentFormat = new SpreadsheetDocumentFormat((int)format);
workbook.SaveDocument(resultStream, documentFormat, encryptionSettings);
}
office-file-api-ai-implementation/CS/BusinessObjects/Helpers.cs#L129
else
workbook.SaveDocument(resultStream, documentFormat, encryptionSettings);
}
SaveDocument(Stream, DocumentFormat, EncryptionSettings)
See Also