Workbook.SaveDocument(String, DocumentFormat, EncryptionSettings) Method

Saves the document to a file 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

C#

public void SaveDocument(
    string fileName,
    DocumentFormat format,
    EncryptionSettings encryptionSettings
)

VB.NET

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

Parameters

Name	Type	Description
fileName	String	Specifies the file path to save the document.
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:

C#

// 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", DocumentFormat.Xlsx, encryptionSettings);

VB.NET

' 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", 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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SaveDocument(String, 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.

VB.NET

spreadsheet-document-api-encryption/VB/EncryptionExample/Program.vb#L35

Dim fileName As String = String.Format("EncryptedwithNewPassword.{0}", answerFormat)
workbook.SaveDocument(fileName, documentFormat, encryptionOptions)
If IsValid = True Then

Implements

SaveDocument(String, DocumentFormat, EncryptionSettings)