.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

Workbook.SaveDocument(Stream, DocumentFormat, EncryptionSettings) Method

Saves the document to a stream in the specified format and with the specified encryption settings.

You need an active 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.v20.1.dll

Declaration

public void SaveDocument(
    Stream stream,
    DocumentFormat format,
    EncryptionSettings encryptionSettings
)
Public Sub SaveDocument(
    stream As Stream,
    format As DocumentFormat,
    encryptionSettings As 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);
}
See Also