Skip to main content
.NET Framework 4.5.2+

RichEditDocumentServer.EncryptedFilePasswordCheckFailed Event

Occurs when the encryption password is empty or invalid.

Namespace: DevExpress.XtraRichEdit

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


public event EncryptedFilePasswordCheckFailedEventHandler EncryptedFilePasswordCheckFailed

Event 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 error type caused the event to raise.
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 prompt with a password again.


Hanlde the EncryptedFilePasswordCheckFailed event to determine the password error (RichEditDecryptionError.PasswordRequired or RichEditDecryptionError.WrongPassword, and specify whether to enable a new password request (TryAgain).

If the TryAgain property is set to true, the RichEditDocumentServer.EncryptedFilePasswordRequested event occurs. The RichEditDocumentServer.InvalidFormatException event fires when the TryAgain property is not specifies or set to false.

The code sample below shows how to handle the RichEditDocumentServer.EncryptedFilePasswordRequested and RichEditDocumentServer.EncryptedFilePasswordCheckFailed events to prompt users to enter a password. If the user cancels the operation, the RichEditDocumentServer loads an empty file.

View Example

private static void Server_EncryptedFilePasswordRequested(object sender, EncryptedFilePasswordRequestedEventArgs e)
    //Prompt the user to enter the password
    Console.WriteLine("Enter password:");
    e.Password = Console.ReadLine();
    e.Handled = true;

private static void Server_EncryptedFilePasswordCheckFailed(object sender, EncryptedFilePasswordCheckFailedEventArgs e)
    //Analyze the password error:
    switch (e.Error)
        //If the password is empty, raise the request again
        case RichEditDecryptionError.PasswordRequired:
            Console.WriteLine("You did not enter the password!");
            e.TryAgain = true;
            e.Handled = true;
        //If the password is invalid, ask user whether to continue the operation:
        case RichEditDecryptionError.WrongPassword:
            Console.WriteLine("The password is incorrect. Try Again? (yes/no)");
            string answer = Console.ReadLine()?.ToLower();
            if (answer == "y")
                e.TryAgain = true;
                e.Handled = true;
            //If user cancels the operation, open an empty file:
                Console.WriteLine("Password check failed. Loading an empty file...");

private static void Server_InvalidFormatException(object sender, RichEditInvalidFormatExceptionEventArgs e)
    RichEditDocumentServer server = (RichEditDocumentServer)sender;

    //Save and open the resulting file
    server.SaveDocument("EmptyFile.docx", DocumentFormat.OpenXml);

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


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.

See Also