PdfDocumentView Class

Definition

Namespace: Xfinium.Pdf.View

Defines a viewer control for PDF files.

public class PdfDocumentView : 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 → PdfDocumentView

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 PDF files. Set the Document property to display the desired PDF document. Set the Zoom property to adjust the zoom level. Use the PageDisplayLayout property to specify how the pages are arranged in the viewer. The UserInteractionMode property can be used to specify how the user interacts with the PDF document displayed in the viewer.

PdfDocumentView control

The control can display PDF files loaded from a file or from a stream. The document can be loaded entirely in memory

1
2

// sample.pdf is loaded entirely in memory, it can be deleted from disk after this call.
documentView.Document.Load(new PdfFixedDocument("sample.pdf"));

1
2
3

// sample.pdf is loaded on demand, it cannot be deleted from disk after this call,
// the file must be available as long as it is displayed in the viewer.
documentView.Document.Load("sample.pdf");

Page display layouts

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

1
2

// The PDF pages are displayed on 3 columns.
documentView.PageDisplayLayout = new PdfColumnBasedPageDisplayLayout(3);

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);

To display the document in single page mode the fixed grid layout is used, specified by the PdfFixedGridPageDisplayLayout class.

1
2

// The control displays a single PDF page by specifying a grid of 1 row and 1 column.
documentView.PageDisplayLayout = new PdfFixedGridPageDisplayLayout(1, 1);

Page zooming

The PDF pages can be zoomed in and out using the Zoom property. The zoom level can be specified as a percentage of the original page size (100% zoom is the original size), or by using the PdfZoomMode enumeration to specify a zoom mode. The pages can also be zoomed in and out using the CTRL key + mouse wheel or on touch devices by pinching the screen.

User interaction

The UserInteractionMode property can be used to specify how the user interacts with the PDF document displayed in the viewer. The user can select text or rectangular page areas (PdfUserInteractionMode.SelectContent mode), can add annotations to the document (any of the PdfUserInteractionMode.Add-Annotation modes), can add form fields to the document (any of the PdfUserInteractionMode.Add-Field modes) or can highlight/underline text in the document (PdfUserInteractionMode.HighlightText and PdfUserInteractionMode.FlatUnderlineText modes).

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 connect the document view to a PdfVisualDocument:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

public AppForm()
{
    InitializeComponent();

    // ...

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

    // ...
}

1
2
3
4
5
6
7
8

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

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

Constructor

Properties

Methods

Events