PdfThumbnailsView Class

Definition

Namespace: Xfinium.Pdf.View

Defines a viewer control for PDF page thumbnails.

public class PdfThumbnailsView : Control, IComponent, IDisposable, IOleControl, IOleObject, IOleInPlaceObject, IOleInPlaceActiveObject, IOleWindow, IViewObject, IViewObject2, IPersist, IPersistStreamInit, IPersistPropertyBag, IPersistStorage, IQuickActivate, ISupportOleDropSource, IDropTarget, ISynchronizeInvoke, IWin32Window, IArrangedElement, IBindableComponent, IKeyboardToolTip, IHandle, IPdfView

Inheritance: Object → MarshalByRefObject → Component → Control → PdfThumbnailsView

Implements: IComponent, IDisposable, IOleControl, IOleObject, IOleInPlaceObject, IOleInPlaceActiveObject, IOleWindow, IViewObject, IViewObject2, IPersist, IPersistStreamInit, IPersistPropertyBag, IPersistStorage, IQuickActivate, ISupportOleDropSource, IDropTarget, ISynchronizeInvoke, IWin32Window, IArrangedElement, IBindableComponent, IKeyboardToolTip, IHandle, IPdfView

Remarks

Use this control to display thumbnails of PDF pages.

PdfThumbnailsView control

Set the Document property to display the desired PDF document and the DocumentView property to link it to a document view. When the user clicks on a thumbnail in the PdfThumbnailsView, the corresponding page in the linked PdfDocumentView will be displayed, allowing for easy navigation through the PDF document.

Page display layouts

The pages in the thumbnails viewer can be arranged in different layouts, column or row oriented, the PageDisplayLayout property being responsible for specifying the layout.
The column oriented layout is specified by the PdfColumnBasedPageDisplayLayout class.

1
2

// The thumbnails are displayed on a single column.
documentView.PageDisplayLayout = new PdfColumnBasedPageDisplayLayout(1);

The row oriented layout is specified by the PdfRowBasedPageDisplayLayout class.

1
2

// The PDF pages are displayed on a single row.
documentView.PageDisplayLayout = new PdfRowBasedPageDisplayLayout(1);

1
2

// The thumbnails are displayed on multiple columns based on the available width of the control.
documentView.PageDisplayLayout = new PdfColumnBasedPageDisplayLayout(0);

Page zooming

The thumbnails can be enlarged or reduced using the Zoom property. The zoom level is specified as a percentage of the original page size (100% zoom is the original size).

Pages reordering

The thumbnails can be reordered by dragging and dropping them to a new position. The user can select one or multiple thumbnails (multiple thumbnails are selected by drawing a selection rectangle over the desired thumbnails) and drag them to a new position in the list.
When the user drops the thumbnails, the BeforePageReorder and AfterPageReorder events are raised. The page reordering can be cancelled by handling the BeforePageReorder event and setting the PdfVisualPageReorderEventArgs.Cancel property to true. In this case, the pages will not be reordered and the AfterPageReorder event will not be raised.
The location of the dropped thumbnails, before or after an existing thumbnail, is indicated by the blue arrow shown in the following image. The pages reordering feature can be disabled by setting the AllowPagesReorder property to false.

Context menus

The viewer control can display a default context menu depending on where the user right clicks on the document.

Page context menu

When the user right clicks on a PDF page, the default context menu is displayed, allowing the user to rotate the page or delete it. The following options are available in the default page context menu:

• — Rotate page 90 degrees clockwise.

• — Rotate page 90 degrees counterclockwise

• — Delete page. When the user clicks this option the BeforePageDelete and AfterPageDelete events are raised. The page deletion can be cancelled by handling the BeforePageDelete event and setting the PdfVisualPageDeleteEventArgs.AllowDelete property to false. In this case, the page will not be deleted and the AfterPageDelete event will not be raised.

The default context menu can be disabled by setting the ShowDefaultPageContextMenu property to false.

Example

In your form's constructor initialize the PdfThumbnailsView and link it to a PdfDocumentView as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

public AppForm()
{
    InitializeComponent();

    // ...

    document = new PdfVisualDocument();
    documentView.Document = document;
    thumbnailsView.Document = document;
    thumbnailsView.DocumentView = documentView;

    // ...
}

1
2
3
4
5
6
7
8
9

protected override void OnFormClosing(FormClosingEventArgs e)
{
    base.OnFormClosing(e);

    document.Close();
    documentView.Dispose();
    thumbnailsView.Dispose();
    document.Dispose();
}

Constructor

Properties

Methods

Events