Workbook.EncryptedFilePasswordCheckFailed Event
Occurs when the encryption password is empty or invalid.
You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Docs.v23.2.dll
NuGet Package: DevExpress.Document.Processor
Declaration
public event EncryptedFilePasswordCheckFailedEventHandler EncryptedFilePasswordCheckFailedEvent Data
The EncryptedFilePasswordCheckFailed event's data class is EncryptedFilePasswordCheckFailedEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| DocumentName | Gets the encrypted document’s name. |
| Error | Obtains the password error. |
| Handled | Gets or sets a value that indicates whether the event handler has completely handled the event or whether the system should continue its own processing. Inherited from HandledEventArgs. |
| TryAgain | Gets or sets whether to request a password again. |
Remarks
Hanlde the EncryptedFilePasswordCheckFailed event to determine the password error (PasswordRequired or WrongPassword), and specify whether to enable a new password request (TryAgain).
If the TryAgain property is set to true, the Workbook.EncryptedFilePasswordRequest event occurs. The Workbook.InvalidFormatException event fires when the TryAgain property is not specifies or set to false.
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the EncryptedFilePasswordCheckFailed event.
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.