Skip to main content

PdfViewerControl.GetDocumentPassword Event

Occurs when requesting a security password to open a protected PDF file.

Namespace: DevExpress.Xpf.PdfViewer

Assembly: DevExpress.Xpf.PdfViewer.v24.1.dll

NuGet Package: DevExpress.Wpf.PdfViewer

Declaration

public event GetDocumentPasswordEventHandler GetDocumentPassword

Event Data

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

Property Description
Handled Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
Password Specifies the security password to open a PDF file.
PasswordRequestsCount Returns the current number of password request attempts.
Path Returns the path to a PDF file that is requested to be opened in the PDF Viewer.
RoutedEvent Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

The event data class exposes the following methods:

Method Description
InvokeEventHandler(Delegate, Object) When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object) When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

The code snippet below illustrates how to use this event.

private void PdfViewer_GetDocumentPassword(DependencyObject d, DevExpress.Xpf.PdfViewer.GetDocumentPasswordEventArgs e)  {

     System.Security.SecureString testString = new System.Security.SecureString();
     testString.AppendChar('1');
     testString.AppendChar('2');
     testString.AppendChar('3');
     testString.AppendChar('4');
     testString.AppendChar('5');
     testString.AppendChar('6');

     e.Password = testString;
     e.Handled = true;
}
See Also