Back to Devexpress

Workbook.SaveDocument(DocumentFormat, EncryptionSettings) Method

officefileapi-devexpress-dot-spreadsheet-dot-workbook-dot-savedocument-x28-devexpress-dot-spreadsheet-dot-documentformat-devexpress-dot-spreadsheet-dot-encryptionsettings-x29.md

latest4.2 KB
Original Source

Workbook.SaveDocument(DocumentFormat, EncryptionSettings) Method

Saves the document to an array of bytes 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

Declaration

csharp
public byte[] SaveDocument(
    DocumentFormat format,
    EncryptionSettings encryptionSettings
)
vb
Public Function SaveDocument(
    format As DocumentFormat,
    encryptionSettings As EncryptionSettings
) As Byte()

Parameters

NameTypeDescription
formatDocumentFormat

A DocumentFormat enumeration value that specifies the document’s format.

| | encryptionSettings | EncryptionSettings |

Specifies encryption options.

|

Returns

TypeDescription
Byte[]

A byte array that contains encrypted data in the specified format.

|

Remarks

This SaveDocument method overload can be used to store a workbook in an external database. Refer to the How to: Store a Workbook in the Database document for more information.

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 to a byte array.
byte[] docBytes = workbook.SaveDocument(DocumentFormat.Xlsx, encryptionSettings);
vb
' 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 to a byte array.
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.

Implements

SaveDocument(DocumentFormat, EncryptionSettings)

See Also

Workbook Class

Workbook Members

DevExpress.Spreadsheet Namespace