PDFThumbnailsView¶
Namespace: O2S.Components.PDF4NET.View
Defines a viewer control for PDF page thumbnails.
Inheritance Object → MarshalByRefObject → Component → Control → PDFThumbnailsView
Implements IPDFView
Remarks
Use this control to display thumbnails of PDF pages.
Set the PDFThumbnailsView.Document property to display the desired PDF document and the PDFThumbnailsView.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.
Note
To ensure proper functionality, please make sure the value of the PDFThumbnailsView.Document property matches the document set in the linked PDFDocumentView. Otherwise, the thumbnail navigation may not work as expected.
Example
In your form's constructor initialize the PDFThumbnailsView and link it to a PDFDocumentView as follows:
public AppForm()
{
InitializeComponent();
// ...
document = new PDFVisualDocument();
documentView.Document = document;
thumbnailsView.Document = document;
thumbnailsView.DocumentView = documentView;
// ...
}
When the form is closed, the viewer controls need to be disposed explicitly as follows:
protected override void OnFormClosing(FormClosingEventArgs e)
{
base.OnFormClosing(e);
document.Close();
documentView.Dispose();
thumbnailsView.Dispose();
document.Dispose();
}
Constructors¶
PDFThumbnailsView()¶
Initializes a new PDFThumbnailsView object.
Properties¶
AccessibilityObject¶
Property Value
AccessibleDefaultActionDescription¶
Property Value
AccessibleDescription¶
Property Value
AccessibleName¶
Property Value
AccessibleRole¶
Property Value
AllowDrop¶
Property Value
Anchor¶
Property Value
AutoScrollOffset¶
Property Value
BackColor¶
Property Value
BackgroundImage¶
Property Value
BackgroundImageLayout¶
Property Value
BindingContext¶
Property Value
Bottom¶
Property Value
Bounds¶
Property Value
CanFocus¶
Property Value
CanSelect¶
Property Value
Capture¶
Property Value
CausesValidation¶
Property Value
ClientRectangle¶
Property Value
ClientSize¶
Property Value
CompanyName¶
Property Value
Container¶
Property Value
ContainsFocus¶
Property Value
ContentPosition¶
Gets the content position.
Property Value
Point
The position of the content displayed in the viewer control.
Remarks
The position is relative to the top left corner of the viewer control.
ContentSize¶
Gets the content size.
Property Value
Size
The size of the content displayed in the viewer control.
ContextMenu¶
Property Value
ContextMenuStrip¶
Property Value
Controls¶
Property Value
Created¶
Property Value
Cursor¶
Property Value
DataBindings¶
Property Value
DeviceDpi¶
Property Value
DisplayRectangle¶
Property Value
Disposing¶
Property Value
Dock¶
Property Value
Document¶
Gets or sets the document displayed in the viewer.
Property Value
PDFVisualDocument
A visual document that encapsulates the file to be displayed.
DocumentView¶
Gets or sets the associated document view.
Property Value
PDFDocumentView
A PDFDocumentView that represents the document view associated with the thumbnails.
Remarks
When a page is clicked in the thumbnails view, the corresponding page in the document view is displayed.
Enabled¶
Property Value
Focused¶
Property Value
Font¶
Property Value
ForeColor¶
Property Value
GraphicRendererFactory¶
Gets or sets the graphic renderer factory.
Property Value
IGraphicRendererFactory
A factory for creating graphic renderers used by the PDF rendering process.
Handle¶
Property Value
HasChildren¶
Property Value
Height¶
Property Value
ImeMode¶
Property Value
InvokeRequired¶
Property Value
IsAccessible¶
Property Value
IsDisposed¶
Property Value
IsHandleCreated¶
Property Value
IsMirrored¶
Property Value
LayoutEngine¶
Property Value
Left¶
Property Value
Location¶
Property Value
Margin¶
Property Value
MaximumSize¶
Property Value
MinimumSize¶
Property Value
Name¶
Property Value
Padding¶
Property Value
PageDisplayLayout¶
Gets or sets the current page display layout.
Property Value
Remarks
The page display layout defines how the PDF pages are arranged and displayed in the viewer control.
PageNumber¶
Gets or sets the page number.
Property Value
Int32
The number of the page to be displayed in the viewer.
Parent¶
Property Value
PreferredSize¶
Property Value
ProductName¶
Property Value
ProductVersion¶
Property Value
RecreatingHandle¶
Property Value
Region¶
Property Value
Right¶
Property Value
RightToLeft¶
Property Value
ShowAnnotations¶
Gets or sets a value indicating whether the annotations should be displayed or not.
Property Value
Boolean
True if the annotations should be displayed, false otherwise. Default is true.
ShowDefaultPageContextMenu¶
Gets of sets a flag indicating whether the default page context menu should be displayed when right-clicking on a page.
Property Value
Boolean
True if default page context menu should be displayed.
ShowFormFields¶
Gets or sets a value indicating whether the form fields should be displayed or not.
Property Value
Boolean
True if the form fields should be displayed, false otherwise. Default is true.
ShowPageNumbers¶
Gets or sets a flag indicating whether page numbers should be displayed.
Property Value
Boolean
True if page numbers should be displayed.
Remarks
When set to true, the viewer will display page numbers under each thumbnail.
Site¶
Property Value
Size¶
Property Value
TabIndex¶
Property Value
TabStop¶
Property Value
Tag¶
Property Value
Text¶
Property Value
Top¶
Property Value
TopLevelControl¶
Property Value
UseWaitCursor¶
Property Value
Visible¶
Property Value
Width¶
Property Value
Zoom¶
Gets or sets the zoom level.
Property Value
Int32
The zoom level used for displaying the PDF pages.
Methods¶
ConvertPagePointToViewerPoint(Int32, PDFPoint)¶
Converts a page point in page visual coordinates to a viewer point in viewer coordinates.
Parameters
pageNumber Int32
The page number for which the conversion is performed.
pagePoint PDFPoint
The page point in visual coordinates (PDF points relative to top left corner of the visible page area)
Returns
Point
A object in viewer coordinates, relative to top left corner of the viewer control.
GetVisiblePages()¶
Gets the list of visible pages.
Returns
Int32[]
An array of page numbers, specifying the pages that are visible in the viewer.
ScrollToPageLocation(PDFVisualPage, Double, Double)¶
Scrolls the viewer to the specified page at the given location.
Parameters
visualPage PDFVisualPage
The page to scroll to.
x Double
Location's x coordinate on the page where to scroll.
y Double
Location's Y coordinate on the page where to scroll.
Events¶
AfterPageDelete¶
Gets or sets the event that is fired after a page has been deleted.
BackColorChanged¶
BackgroundImageChanged¶
BackgroundImageLayoutChanged¶
BeforePageDelete¶
Gets or sets the event that is fired when a page is about to be deleted using the default page context menu.
BindingContextChanged¶
CausesValidationChanged¶
ChangeUICues¶
Click¶
ClientSizeChanged¶
ContentPainted¶
Gets or sets the event that is fired after the viewer content has been drawn.
ContentPositionChanged¶
Gets or sets the event that is fired when the content position has changed.
ContentSizeChanged¶
Gets or sets the event that is fired when the size of displayed content changes.
ContextMenuChanged¶
ContextMenuStripChanged¶
ControlAdded¶
ControlRemoved¶
CursorChanged¶
Disposed¶
DockChanged¶
DoubleClick¶
DpiChangedAfterParent¶
DpiChangedBeforeParent¶
DragDrop¶
DragEnter¶
DragLeave¶
DragOver¶
EnabledChanged¶
Enter¶
FontChanged¶
ForeColorChanged¶
GiveFeedback¶
GotFocus¶
HandleCreated¶
HandleDestroyed¶
HelpRequested¶
ImeModeChanged¶
Invalidated¶
KeyDown¶
KeyPress¶
KeyUp¶
Layout¶
Leave¶
LocationChanged¶
LostFocus¶
MarginChanged¶
MouseCaptureChanged¶
MouseClick¶
MouseDoubleClick¶
MouseDown¶
MouseEnter¶
MouseHover¶
MouseLeave¶
MouseMove¶
MouseUp¶
MouseWheel¶
Move¶
PaddingChanged¶
PageClick¶
Gets or sets the event that is fired when a page has been clicked.
PageContextMenu¶
Gets or sets the event that is fired when a page context menu should be displayed.
PageDoubleClick¶
Gets or sets the event that is fired when a page has been double clicked.
PageNumberChanged¶
Gets or sets the event that is fired when the page number has changed.
PageRenderingCancelled¶
Gets or sets the event that is fired when the page stops displaying content.
PageRenderingCompleted¶
Gets or sets the event that is fired when the page content for the page visible area is displayed in full.
PageRenderingStarted¶
Gets or sets the event that is fired when a page begins to be displayed.
Paint¶
ParentChanged¶
PreviewKeyDown¶
QueryAccessibilityHelp¶
QueryContinueDrag¶
RegionChanged¶
Resize¶
RightToLeftChanged¶
SizeChanged¶
StyleChanged¶
SystemColorsChanged¶
TabIndexChanged¶
TabStopChanged¶
TextChanged¶
Validated¶
Validating¶
VisibleChanged¶
ZoomChanged¶
Gets or sets the event that is fired when the zoom has changed.