You are here: GdPicture.NET > Documentation > Classes > GdViewer Class
logo.gif
ContentsIndexHome
PreviousUpNext
GdViewer Class
C#
public class GdViewer : System.Windows.Forms.UserControl;
Visual Basic
Public Class GdViewer
Inherits System.Windows.Forms.UserControl

GdViewer class is an embeddable control of the GdPicture.NET suite to display raster image, metafile and PDF documents. 

 

 

GdViewer in available in the following GdPicture.NET editions: 

  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK. *
  • GdPicture.NET Document Viewer SDK.
 

 

* PDF viewing is not available for the GdPicture.NET Image SDK. 

 

 

 

Note: Each GdViewer object must be unlocked using the SetLicenseNumber() method. 

Name 
Description 
The categories of the GdViewer class are listed here. 
The categories of the GdViewer class are listed here. 
The categories of the GdViewer class are listed here. 
The following tables list the members exposed by GdViewer. 
 
Name 
Description 
 
Occurs after changing displayed document.  
 
Occurs after a page is printed.  
 
Occurs after changing level of zoom.  
 
Occurs before changing displayed document.  
 
Occurs before a page is printed.  
 
Occurs before changing level of zoom.  
 
Occurs when an item of the contextual menu has been clicked.  
 
Occurs when data has received after the of the DisplayFromURL() function.  
 
Occurs when changing page of the displayed document.  
 
Occurs when a page has been successfully displayed.  
 
Occurs if a password is needed to decrypt the loaded PDF. This event is raised when the PDFShowDialogForPassword property have been set to False.  
 
Occurs when the rectangle of area selection is edited by the user.  
 
Occurs when a region is edited by the user.  
 
Occurs when the displayed document is rotated.  
 
Occurs when the user scrolls through the client area using the vertical or the horizontal scrollbar.  
 
Available in COM edition only ! Occurs when the viewer is double clicked.  
 
Available in COM edition only ! Occurs when the viewer is double clicked.  
 
Available in COM edition only ! Occurs when a key is pressed while the viewer has focus.  
 
Available in COM edition only ! Occurs when a key is pressed while the viewer has focus.  
 
Available in COM edition only ! Occurs when a key is released while the viewer has focus.  
Name 
Description 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK. *
  • GdPicture.NET Document Viewer SDK.


* The Image SDK edition does not support PDF format.  
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Document Viewer SDK.

 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
These methods are available in:
  • GdPicture.NET Document Imaging SDK Ultimate.
  • GdPicture.NET Document Imaging SDK.
  • GdPicture.NET Image SDK.
  • GdPicture.NET Document Viewer SDK.
 
 
Name 
Description 
 
Defines if by default the viewer must animate loaded multiframe GIF images. True by default.  
 
For multipage documents viewing, determines if the viewer displays automatically the next or the previous page when the user scroll the current page.  
 
Current page of the displayed document.  
 
The cursor that appears when the pointer moves over the viewer.
Default value allows the Viewer to display his own cursors when panning or moving the rectangle of area selection.  
 
Defines the level of displaying quality.  
 
Defines if the level of displaying quality is automatic or not.  
 
Default image alignment within the viewer when the area of the viewer if smaller than the displayed document in its current zoom configuration.
IE: set this property to ImagePositionTopLeft to show to top-left area of the image when the user make a positive zoom.  
 
Default page position within the viewer when the displayed document in its current zoom configuration if smaller than then area of the viewer.  
 
To enable or disable the viewer contextual menu.  
 
Specifies whether the object can change zoom during to the mouse Wheel events.  
 
Turn this property to True to force the viewer to always displaying scrollbars.  
 
Forces the viewer to use a temporary copy when it displays an image.  
 
Forces the viewer to use a temporary copy when it displays a PDF.  
 
Defines the gamma value, which represents the brightness of the displayed document.
Gamma values range from 0.1 to 5.0 (normally 0.1 to 2.2), where a value less than 1 lightens the image, a value of 1 leaves the image unaffected and an value greater than 1 darkens the image.  
 
The graphics object of the viewer.  
 
Horizontal resolution in DPI (Dot Per Inch) of the current page of the displayed document.  
 
Returns if the horizontal scrollbar is visible or not.  
 
Set to True to ignore vertical & horizontal resolutions measurement when the viewer displays an image.  
 
Defines if the viewer must keep the page position when a new document is loaded.  
 
Turn this property to True to avoid viewer refreshes.  
 
Defines the mouse button used for the MouseMode configuration.  
 
Defines the viewer mouse mode.  
 
Defines the Mouse Wheel function.  
 
Defines if the viewer must optimize drawing speed or document loading time.
True: Decrease dramatically drawing time but increase a bit the document loading time. Suggested for large documents. If used, it is also recommended to set the DisplayQualityAuto to True.
False (default): Increase drawing time but decrease document loading time. Suggested for small documents.  
 
Number of pages in the displayed document.  
 
Height in pixel of the current page of the displayed document.  
 
Width in pixel of the current page of the displayed document.  
 
Defines if the viewer displays form fields included into PDF.  
 
If the PDF to open is protected, the control will prompt the user for a password. Turn this property to False to use your own dialog box (you will have to catch the PDFPasswordRequest event).  
 
Defines the color of the rectangle of area selection.  
 
Defines the border size in pixel of the rectangle of area selection.  
 
Determines if the rectangle of area selection can be moved and resized by the user.  
 
Determines if regions can be moved and resized by the user.  
 
Defines if scrollbars can be displayed or not within the viewer.  
 
Scrollbars large change value.  
 
Scrollbars small change value.  
 
Turn this property to True to deactivate error reporting through MessageBox.  
 
Vertical resolution in DPI (Dot Per Inch) of the current page of the displayed document.  
 
Returns if the vertical scrollbar is visible or not.  
 
Zoom 
Zoom factor.
1 for 100%, 1.5 for 150%, 2 for 200%...  
 
Defines if during a zoom operation the document must be centered at the current mouse position.  
 
The maximum zoom factor which can be used with the displayed document.  
 
Zoom mode used by the viewer.  
 
Defines the percentage of increasing or decreasing of the level of zoom for Zoom In & Zoom Out operations.
Default is 25.  
What do you think about this topic? Send feedback!
Copyright (c) 2009-2011 www.gdpicture.com. All rights reserved.