Workbook.SaveDocument(String, EncryptionSettings) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

Saves the document to a file in the Excel or text format with the specified encryption settings. The file format is identified by the file extension.

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

csharp

public void SaveDocument(
    string fileName,
    EncryptionSettings encryptionSettings
)

Public Sub SaveDocument(
    fileName As String,
    encryptionSettings As EncryptionSettings
)

Parameters

Name	Type	Description
fileName	String

Specifies the file path to save the document.

| | encryptionSettings | EncryptionSettings |

Specifies encryption options.

Remarks

The DocumentFormat enumeration lists the supported document formats. To export a file to PDF or HTML, use the Workbook.ExportToPdf and Workbook.ExportToHtml methods.

This SaveDocument method overload allows you to encrypt a workbook with a password, as shown below:

C#
VB.NET

csharp

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

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

// Specify encryption settings.
EncryptionSettings encryptionSettings = new EncryptionSettings();
encryptionSettings.Type = DevExpress.Spreadsheet.EncryptionType.Strong;
encryptionSettings.Password = "password";

// Save the document.
workbook.SaveDocument("Document.xlsx", encryptionSettings);

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

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.
workbook.SaveDocument("Document.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.

Implements

SaveDocument(String, EncryptionSettings)