RichEditDocumentServer.DecryptionFailed Event

Occurs if the RichEditDocumentServer failed to open an encrypted file.

Namespace: DevExpress.XtraRichEdit

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

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

Declaration

C#

public event DecryptionFailedEventHandler DecryptionFailed

VB.NET

Public Event DecryptionFailed As DecryptionFailedEventHandler

Event Data

The DecryptionFailed event's data class is DecryptionFailedEventArgs. The following properties provide information specific to this event:

Property	Description
Exception	Returns an exception that led to the event.

Remarks

The DecryptionFailed event is raised when the RichEditDocumentServer cannot decrypt a loaded file. Check the Exception property to determine the exception that led to this event.

The event also occurs if the EncryptedFilePasswordCheckFailedEventArgs.TryAgain property is not specified or set to false.

If the event is not handled, the RichEditDocumentServer does not load an empty file.

The code sample below shows how to handle the DecryptionFailed event to show an exception message.

View Example

C#

private static void Server_DecryptionFailed(object sender, DecryptionFailedEventArgs e)
{
    Console.WriteLine(e.Exception.Message.ToString()+" Press any key to close...");
    Console.ReadKey(true);
}

VB.NET

Private Shared Sub Server_DecryptionFailed(ByVal sender As Object, ByVal e As DecryptionFailedEventArgs)
    Console.WriteLine(e.Exception.Message.ToString() & " Press any key to close...")
    Console.ReadKey(True)
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DecryptionFailed 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.

C#

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

server.EncryptedFilePasswordCheckFailed += Server_EncryptedFilePasswordCheckFailed;
server.DecryptionFailed += Server_DecryptionFailed;

VB.NET

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

AddHandler server.EncryptedFilePasswordCheckFailed, AddressOf Server_EncryptedFilePasswordCheckFailed
AddHandler server.DecryptionFailed, AddressOf Server_DecryptionFailed
server.Options.Import.EncryptionPassword = "test"