EncryptedFilePasswordCheckFailedEventArgs.Error Property

Obtains the error type caused the event to raise.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v23.2.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

public RichEditDecryptionError Error { get; }

VB.NET

Public ReadOnly Property [Error] As RichEditDecryptionError

Property Value

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

Available values:

Name	Description
PasswordRequired	Indicates that the file is encrypted and you should set the RichEditDocumentImportOptions.EncryptionPassword or EncryptedFilePasswordRequestedEventArgs.Password property to a password string
WrongPassword	The password specified by the RichEditDocumentImportOptions.EncryptionPassword property is incorrect.
EncryptionTypeNotSupported	Indicates that the encryption type is not supported. For example, this error occurs when you open a DOC file that uses RC4 CryptoAPI encryption with third-party cryptographic service providers.
IntegrityCheckFailed	Indicates that the document did not pass the HMAC verification.

Remarks

The Error property returns RichEditDecryptionError.PasswordRequired or RichEditDecryptionError.WrongPassword.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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#

word-document-api-open-and-save-encrypted-files/CS/word-processing-encryption/Program.cs#L67

{
    switch (e.Error)
    {

wpf-richedit-document-encryption/CS/DXRichEdit_Encryption/MainWindow.xaml.cs#L86

//Analyze the error led to this event
switch (e.Error)
{

winforms-richedit-document-encryption/CS/RichEditControl_Encryption/Form1.cs#L49

//or create an empty file
switch (e.Error)
{

VB.NET

word-document-api-open-and-save-encrypted-files/VB/word-processing-encryption/Program.vb#L52

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

wpf-richedit-document-encryption/VB/DXRichEdit_Encryption/MainWindow.xaml.vb#L81

'Analyze the error led to this event
Select Case e.Error
    Case RichEditDecryptionError.PasswordRequired

winforms-richedit-document-encryption/VB/RichEditControl_Encryption/Form1.vb#L41

'or create an empty file
Select Case e.Error
    Case RichEditDecryptionError.PasswordRequired