EncryptedFilePasswordCheckFailedEventArgs.Error Property

Obtains the password error.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

public SpreadsheetDecryptionError Error { get; }

VB.NET

Public ReadOnly Property [Error] As SpreadsheetDecryptionError

Property Value

Type	Description
SpreadsheetDecryptionError	One of the SpreadsheetDecryptionError enumeration values indicating the error type.

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. For example, this error occurs when you open an XLS file that uses RC4 CryptoAPI encryption with third-party cryptographic service providers.
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#

spreadsheet-document-api-encryption/CS/EncryptionExample/Program.cs#L80

{
    switch (e.Error)
    {

VB.NET

spreadsheet-document-api-encryption/VB/EncryptionExample/Program.vb#L62

Private Shared Sub Workbook_EncryptedFilePasswordCheckFailed(ByVal sender As Object, ByVal e As EncryptedFilePasswordCheckFailedEventArgs)
    Select Case e.Error
        Case SpreadsheetDecryptionError.PasswordRequired