Events

PSPDFKit for Windows exposes specific events for applications to consume. These events are mainly related to user actions. They’re raised after key UI interactions and data manipulation, which allows users more control over their PdfViews.

After a PdfView is instantiated, subscribing to events is straightforward, as one would expect in C#:

1
PDFView.InitializationCompletedHandler += PDFViewOnInitializationCompletedHandler;
1
2
3
4
private void PDFViewOnInitializationCompletedHandler(PdfView sender, Document args)
{
	// ...
}

In addition to their specific arguments, events also include the sender object in their event handlers.

Structure

Events are found in four major classes:

The primary source for events is the Controller class, which should be where you look first. A number of events related to the view and its state are also found in the PdfView class — most notably, the InitializationCompletedHandler event shown above.

Events related to bookmarks and annotations that aren’t necessarily tied to the UI are part of the Document class, while search events are found in the Library class. More details about PSPDFKit for Windows’ capabilities for indexed search can be found here.

Finally, custom ToolbarItems expose their own press events. You can read more about customizing the toolbar here.

For working code samples, the Catalog example app has a section for events. Moreover, a detailed view of each event can be found in the documentation for its respective parent class.

Annotations

Annotations have several events associated with them, mainly regarding user interaction, with the IAnnotation object interacted with being passed through in the event arguments. Considering annotations have unique IDs, and given your application subscribes to the relevant events, managing them and adapting interactions to specific use cases is simple.

The following annotation and annotation-related events are included in PSPDFKit for Windows:

The OnAnnotationPressed event has been exposed in the Controller class, and it handles user presses, including information about the pointer used:

Copy
1
2
3
4
5
6
7
8
9
10
11
{
	PDFView.Controller.OnAnnotationPressed += OnAnnotationPressed;
}

private void OnAnnotationPressed(Controller controller, AnnotationPressedEventArgs args)
{
    if (args.Pointer.IsPrimary)
    {
        Debug.Write(args.Annotation.AnnotationType);
    }
}

Preventing the default behavior of an annotation is also possible through the same event. Note that this is not supported inside async event handlers:

Copy
1
2
3
4
5
6
7
private void OnAnnotationPressed(Controller controller, AnnotationPressedEventArgs args)
{
    if (args.Annotation.AnnotationType == AnnotationType.Ink)
    {
        args.PreventDefault = true;
    }
}

Detecting when annotations will change can be done with the aptly named OnAnnotationsWillChange event, which is also found in the Controller. Before user actions cause annotation changes, this event is invoked, and it states the reason and lists the affected annotations:

Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
	PDFView.Controller.OnAnnotationsWillChange += OnAnnotationsWillChange;
}

private void OnAnnotationsWillChange(Controller controller, AnnotationsChanging args)
{
    if (args.Reason == AnnotationsWillChangeReason.DrawStart)
    {
        for (var i = 0; i < annotationsChanging.Annotations.Count; i++)
        {
            Debug.Write(annotationsChanging.Annotations[i].Id)
        }
    }
}

A more in-depth introduction to annotations and their uses can be found here.

Bookmarks

Reacting to bookmark actions can be done through the BookmarksCreated, BookmarksDeleted, and BookmarksUpdated events found in the Document class. These can be used to add custom logic and manually manage bookmarks:

Copy
1
2
3
4
5
6
7
document.BookmarksCreated += (view, bookmarks) =>
{
    foreach (var bookmark in bookmarks)
    {
        _bookmarks[bookmark.Id] = bookmark;
    }
};

Additional examples can be found on the events page of the Catalog, and this page presents an overview of bookmarks.

User Interaction

The OnPagePressed event found in the Controller class both informs page-press coordinates and holds information about the pointer used. This allows for better multi-pointer support and specific behavior depending on, for example, the pointer type:

Copy
1
2
3
4
5
6
7
pdfView.Controller.OnPagePressed += (sender, args) =>
{
    if (args.PageIndex == 3 && args.Pointer.PointerId == 1)
    {
        // ...
    }
};

Another useful event regarding user interaction is OnTextSelectionChanged. More information about it can be found here.

Indexed Full-Text Search

The full-text search library exposes a few different events, which gives your application a lot of control over the process:

  • OnFinishedIndexingDocument
  • OnPageIndexed
  • OnPasswordRequested
  • OnSearchComplete
  • OnSearchPreviewComplete
  • OnSearchTimedOut
  • OnStartIndexingDocument

Examples of these events are detailed on the Full-Text-Search page of the Catalog project and in the Indexed Full-Text Search guide.