PdfViewer.PasswordRequested Event
Occurs when requesting a security password to open a protected PDF file.
Namespace: DevExpress.XtraPdfViewer
Assembly: DevExpress.XtraPdfViewer.v24.2.dll
NuGet Package: DevExpress.Win.PdfViewer
#Declaration
public event PdfPasswordRequestedEventHandler PasswordRequested
#Event Data
The PasswordRequested event's data class is PdfPasswordRequestedEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
File |
Returns the file name of a document that is requested to be opened in the PDF Viewer or PDF Document Processor. |
File |
Returns the path of the file requested to be opened in the PDF Viewer or PDF Document Processor. |
Password |
Obsolete. This property is now obsolete. Use the Pdf |
Password |
Returns the current number of password request attempts. |
Password |
Specifies the security password to open a PDF file. |
#Remarks
To interrupt the password request process, the PdfPasswordRequestedEventArgs.PasswordString property value should be set to null.
To change the maximum number of allowed attempts to enter the PDF file’s security password, use the PdfViewer.PasswordAttemptsLimit property (the default value is 1).
#Example
The following code illustrates the use of the PdfViewer.PasswordRequested
event.
using System.Windows.Forms;
using DevExpress.Pdf;
// ...
private void pdfViewer1_PasswordRequested(object sender, PdfPasswordRequestedEventArgs e)
{
e.PasswordString = "password"
}