EncryptionOptions Interface

Contains the workbook encryption options.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v18.2.Core.dll

Declaration

C#

public interface EncryptionOptions

VB.NET

Public Interface EncryptionOptions

Related API Members

The following members return EncryptionOptions objects:

• DocumentSettings.Encryption

Remarks

The EncryptionOptions class properties are used to specify the encryption type and a password for saving a workbook to a password encrypted file. An instance of this class is accessible using the SpreadsheetControl.Document.DocumentSettings.Encryption notation.

Example

This code snippet obtains the DocumentSettings.Encryption settings selected in the editors and prompts for saving a password encrypted file.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-load-and-save-a-password-encrypted-file-t464814

Form1.vb

Dim workbook As IWorkbook = spreadsheetControl1.Document
workbook.DocumentSettings.Encryption.Type = DirectCast(System.Enum.Parse(GetType(EncryptionType), barEncryptionTypeComboBox.EditValue.ToString()), EncryptionType)
workbook.DocumentSettings.Encryption.Password = barPasswordEdit.EditValue.ToString()
spreadsheetControl1.SaveDocumentAs()

Form1.cs

IWorkbook workbook = spreadsheetControl1.Document;
workbook.DocumentSettings.Encryption.Type = (EncryptionType)Enum.Parse(typeof(EncryptionType), barEncryptionTypeComboBox.EditValue.ToString());
workbook.DocumentSettings.Encryption.Password = barPasswordEdit.EditValue.ToString();
spreadsheetControl1.SaveDocumentAs();