SpreadsheetControl.EncryptedFilePasswordRequest Event

Occurs when the WorkbookImportOptions.Password property is not set or contains the wrong password.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v21.1.dll

Declaration

public event EncryptedFilePasswordRequestEventHandler EncryptedFilePasswordRequest

Event Data

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

Property Description
Cancel Gets or sets a value indicating whether the event should be canceled. Inherited from CancelEventArgs.
DocumentName Gets the name of the encrypted document.
Password Gets or sets the password used to encrypt the document.

Remarks

The EncryptedFilePasswordRequest event allows prompting an end-user for a password or specify it in code using the EncryptedFilePasswordRequestEventArgs.Password property.

If the event is not handled (the e.Handled is not set to true), the Password Dialog appears.

Example

The code snippet handles the SpreadsheetControl.EncryptedFilePasswordRequest event to specify a password for loading a password encrypted file.

View Example

private void SpreadsheetControl1_EncryptedFilePasswordRequest(object sender, EncryptedFilePasswordRequestEventArgs e) {
    if (e.DocumentName == "encrypted_test.xlsx") e.Password = "test";
    if (e.DocumentName == "corrupted.xlsx") e.Password = "000";
    e.Handled = true;
}
See Also