EncryptionOptions Class

Contains encryption options for a workbook.

Namespace: DevExpress.Office.Crypto

Assembly: DevExpress.Printing.v18.1.Core.dll

Declaration

C#

public class EncryptionOptions

VB.NET

Public Class EncryptionOptions

Remarks

To encrypt a document, create an instance of the EncryptionOptions class and pass it as a parameter to the IXlExporter.CreateDocument method. For an example, refer to the How to: Password Protect a Workbook topic.

The EncryptionOptions.Type property allows you to specify the encryption mechanism for XLSX files. By default, the agile encryption is used. XLS files support only RC4 encryption.

To specify an encryption password, use the EncryptionOptions.Password property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the EncryptionOptions class.

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.

C#

excel-export-api-examples-t253492/CS/XLExportExamples/SpreadsheetActions/GeneralActions.cs#L46

// (agile encryption for XLSX files, and RC4 encryption for XLS files).
EncryptionOptions encryptionOptions = new EncryptionOptions();
// Specify the encryption password.

VB.NET

excel-export-api-examples-t253492/VB/XLExportExamples/SpreadsheetActions/GeneralActions.vb#L48

' (agile encryption for XLSX files, and RC4 encryption for XLS files).
Dim encryptionOptions As New EncryptionOptions()
' Specify the encryption password.

Inheritance

Object

EncryptionOptions