Skip to main content
Row

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

Workbook.SaveDocument(Stream, DocumentFormat, EncryptionSettings) Method

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.v24.2.dll

NuGet Package: DevExpress.Document.Processor

#Declaration

public void SaveDocument(
    Stream stream,
    DocumentFormat format,
    EncryptionSettings encryptionSettings
)

#Parameters

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.

#Remarks

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);
}

#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.

See Also