SpreadsheetDecryptionException.Error Property

Provides access to an object containing information about the error that occurs while attempting to decrypt a workbook.

Namespace: DevExpress.XtraSpreadsheet

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

Declaration

C#

public SpreadsheetDecryptionError Error { get; }

VB.NET

Public ReadOnly Property Error As SpreadsheetDecryptionError

Property Value

Type	Description
SpreadsheetDecryptionError	A SpreadsheetDecryptionError object containing information about an error.

Available values:

Name	Description
PasswordRequired	Indicates that an .xls binary file is encrypted and you should set the XlsDocumentImporterOptions.Password property to a password string.
WrongPassword	The password specified by the XlsDocumentImporterOptions.Password property is incorrect.
EncryptionTypeNotSupported	Indicates that the encryption type is not supported. Only the RC4 encryption algorithm is implemented for binary files (XLS). Other encryption methods (XOR obfuscation and RC4 CryptoAPI) are not supported for XLS files.
IntegrityCheckFailed	Indicates that the document being loaded did not pass the HMAC verification.

Related GitHub Examples

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

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#

how-to-open-a-password-protected-xls-file-t162440/CS/PasswordToOpenSample/Form1.cs#L24

if (decryptionException != null && sourceFormat == DocumentFormat.Xls) {
    if (decryptionException.Error == SpreadsheetDecryptionError.PasswordRequired) {
        using (PasswordForm form = new PasswordForm()) {

VB.NET

how-to-open-a-password-protected-xls-file-t162440/VB/PasswordToOpenSample/Form1.vb#L26

If decryptionException IsNot Nothing AndAlso sourceFormat = DocumentFormat.Xls Then
    If decryptionException.Error = SpreadsheetDecryptionError.PasswordRequired Then
        Using form As New PasswordForm()