GdPicture.NET Reference Guide
GdViewer Class Members
Properties  Methods  Events

GdPicture14 Namespace : GdViewer Class

The following tables list the members exposed by GdViewer.

Public Constructors
 NameDescription
Public ConstructorA standard constructor for the GdViewer class. It initializes an instance of the GdViewer class, which subsequently allows you to perform all available operations with supported documents.  
Top
Public Properties
 NameDescription
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertySpecifies if a user is able to drag-and-drop files from the file explorer directly to the control, for example using the mouse.

If this property is set to True/true and a file is dropped within the control, the DropFile event is raised.

 
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertySpecifies whether the GdViewer control must animate the currently loaded multi-frame GIF image by defaut, for example when displaying the image or refreshing the control. If this property is set to True/true, the image will playing in the loop.  
Public PropertyDetermines whether all GdPicture/XMP annotations are rendered with a very light and gentle drop shadow effect on the screen. The shadow effect is not applicable when saving annotations to a file.  
Public PropertyGets or sets the color that is used when drawing the resizing and rotating handles when selecting GdPicture XMP annotations. This value is common for all annotations.

The handles are displayed as visible dots (round marks) respecting both the AnnotationResizeRotateHandlesColor and the AnnotationResizeRotateHandlesScale properties.

 
Public PropertyGets or sets a factor that is used to scale (enlarge or reduce) the size of the resizing and rotating handles when selecting GdPicture XMP annotations. This value is common for all annotations.

The handles are displayed as visible dots (round marks) respecting both the AnnotationResizeRotateHandlesScale and the AnnotationResizeRotateHandlesColor properties.

 
Public PropertyGets or sets the line color of the line that is used to draw the selection rectangle when selecting GdPicture XMP annotations. This value is common for all annotations.

The annotation selection displays as the rectangle, which borders the annotation, so that the line of this rectangle respects the defined annotation selection line color.

 
Public Property (Inherited from System.Windows.Forms.UserControl)
Public Property (Inherited from System.Windows.Forms.UserControl)
Public Property (Inherited from System.Windows.Forms.UserControl)
Public PropertyOverridden. Gets or sets the background color for the control.  
Public Property (Inherited from System.Windows.Forms.UserControl)
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertyDetermines whether the GdViewer control display pages in the multipage document continuously one below another when the user scrolls the current page.

This property is designed for viewing multipage documents. That said, be sure you have set the PageDisplayMode property to PageDisplayMode.MultiplePagesView to allow continuous viewing.

 
Public PropertyGets the page number of the currently selected and displayed page of the document loaded in the GdViewer control. The pages are numbered starting from 1.  
Public PropertyOverridden. Gets or sets the cursor that is displayed when the mouse pointer is over the control.  
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertySpecifies the level of displaying quality according to the used algorithm when manipulating with images.

If you turn off the automatic level of displaying quality using the DisplayQualityAuto property, then the previously defined value of this property other than automatic is used.

 
Public PropertySpecifies if the level of displaying quality according to the used algorithm when manipulating with images is automatic or not.

If you turn off the automatic level of displaying quality by setting this property to False/false, the previously defined value of the DisplayQuality property other than automatic is used.

 
Public Property (Inherited from System.Windows.Forms.ScrollableControl)
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertyGets or sets the default page alignment within the GdViewer control when the area of the control is smaller than the document to be displayed in its current zoom configuration. For example, setting this property to ViewerDocumentAlignment.DocumentAlignmentTopLeft displays the most top-left part of the current page during the zoom-in operation.  
Public PropertyGets or sets the default page position within the GdViewer control when the rendering area of the displayed document in its current zoom configuration is smaller than area of the control.

The toolkit only supports ViewerDocumentPosition.DocumentPositionMiddleCenter if the PageDisplayMode property is other than PageDisplayMode.SinglePageView.

 
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertySpecifies if page painting is deferred in the GdViewer control.

Displaying large bitmaps or complex vector document pages may cause performance issues. In such situations, it might be useful to use deferred page painting.

 
Public PropertySpecifies if a progress bar is displayed in the GdViewer control when performing an operation, which raises a progression callback.

Turning this property to True/true activated the progress bar when loading or saving files using web transfer. If you set this property to False/false, the progress bar will not display.

 
Public PropertySpecifies whether the GdViewer control uses the color correction technique when manipulating with files that embed an ICC profile.

The ICM stands for Image Color Matching and this technique maps color profiles to allows the color system used by one computer device to match the colors used by other applications and devices.

 
Public PropertyEnables or disables displaying the contextual menu in the GdViewer control.  
Public PropertySpecifies whether the GdViewer control will respond to the mouse wheel event. You can use the MouseWheelMode property to define how the mouse wheel event is handled.  
Public PropertySpecifies if text selection is enabled in the GdViewer control, that means, for example, also the ability to copy text from the currently displayed page of the text-based document.

The line selection mode is used by default, holding the Alt-key during selection permits you to switch to the column selection mode.

 
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertyDetermines if both scrollbars must always be visible, whatever the zoom configuration is.

Turning this property to True/true forces the viewer to always display the scrollbars. If you set this property to False/false, both scrollbars will display according to the ScrollBars property.

 
Public PropertyForces the GdViewer control to use a temporary copy of the file when working (loading, displaying, saving) with your document.

Setting this property to True/true allows you to overwrite the displayed document, otherwise, the GdPictureStatus.AccessDenied status is returned when saving. Be sure to set this property to the required value before loading the document. Otherwise, it is not taking into account.

 
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertySpecifies the gamma value (gamma encoding), which represents the brightness of the displayed document in the GdViewer control.

Gamma values range from 0.1 to 5.0, usually 0.1 to 2.2. A value less than 1 lightens the image, a value of 1 leaves the image unaffected, and a value greater than 1 darkens the image.

 
Public PropertyGets the horizontal resolution in DPI (dots per inch) of the current page of the document displayed in the GdViewer control.  
Public PropertySpecifies if annotations are rendered in high quality mode.  
Public PropertyReturns if the horizontal scrollbar is visible, means displayed, or not in the GdViewer control.  
Public PropertyGets or sets whether the GdViewer control will ignore vertical and horizontal resolutions measurement while displaying a document.  
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertySpecifies whether the GdViewer control will keep the page position when the displayed page changes or when a new document is loaded.

If the PageDisplayMode property is other than PageDisplayMode.SinglePageView, this property must be set to False/false.

 
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertyEnables or disables refreshing the GdViewer control.

Turning this property to True/true avoids refreshing the control. Otherwise, the control will refresh if needed.

 
Public PropertyGets or sets the height, in pixels, of the magnifier tool used in the GdViever control. You can enable the use of the magnifier tool in your application by setting the MouseMode property to ViewerMouseMode.MouseModeMagnifier.  
Public PropertyGets or sets the width, in pixels, of the magnifier tool used in the GdViever control. You can enable the use of the magnifier tool in your application by setting the MouseMode property to ViewerMouseMode.MouseModeMagnifier.  
Public PropertyGets or sets the current horizontal zoom (scale) factor of the magnifier tool used in the GdViewer control. You can enable the use of the magnifier tool in your application by setting the MouseMode property to ViewerMouseMode.MouseModeMagnifier.

Please use the value 1 to define the 100% zoom factor, 1.5 to define 150%, 2 to define the 200% zoom factor, etc.

 
Public PropertyGets or sets the current vertical zoom (scale) factor of the magnifier tool used in the GdViewer control. You can enable the use of the magnifier tool in your application by setting the MouseMode property to ViewerMouseMode.MouseModeMagnifier.

Please use the value 1 to define the 100% zoom factor, 1.5 to define 150%, 2 to define the 200% zoom factor, etc.

 
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertyGets or sets the mouse button used for the current mouse mode configuration in the GdViewer control.  
Public PropertyGets or sets the mouse mode, that is how the mouse is used to manipulate with the displayed document.  
Public PropertyGets or sets the mouse wheel mode, that is how the mouse wheel is used to manipulate with the displayed document.

Be aware, that you need to enable the EnableMouseWheel property to properly apply the mouse wheel mode.

 
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertyGets the total number of pages in the document currently displayed in the GdViewer control.  
Public PropertyGets or sets the current page display mode of the GdViewer control.

The single page viewing mode displays only one page at a time in the viewer area. The multi page viewing mode displays all pages one after another.

 
Public PropertyReturns the height, in pixels, of the current page of the document displayed in the GdViewer control.  
Public PropertyReturns the final rendering rotation of the current page of the document displayed in the GdViewer control. It is the sum of the values of the ViewRotation and the PageRotation properties.  
Public PropertyReturns the rotation and flipping of the current page of the document displayed in the GdViewer control.  
Public PropertyReturns the width, in pixels, of the current page of the document displayed in the GdViewer control.  
Public PropertySpecifies whether the GdViewer control will render and print form fields and annotations included in the loaded PDF documents.  
Public PropertySpecifies whether the GdViewer control will automatically navigate to the linked file when a user clicks the associated file link in the displayed PDF document.

PDF documents are often designed to contain links to other files. Such an option is provided through a GoToR action handled by particular objects such as bookmarks or file links. Setting this property to True/true allows users to navigate to the linked file. Turning this property to False/false will disable this behaviour.

The PdfFileNavigation event is raised before displaying the linked file.

 
Public PropertySpecifies whether the GdViewer control will follow a hyperlink contained in the displayed PDF document when a user clicks that hyperlink.

Setting this property to True/true allows users to open web links contained in the loaded PDF documents. Turning this property to False/false will disable this behaviour.

The PdfUriNavigation event is raised before navigating to the specified hyperlink.

 
Public PropertySpecifies if the rendering engine should increase text contrast on low zoom to enhance readability. This feature can decrease rendering speed performances on old machines.  
Public PropertyGets or sets the rasterizer engine used for PDF rendering purposes.  
Public PropertyEnables or disables the option that allows you to utilize your own dialog box requesting a password if the PDF document to display is protected.

If this property is set to True/true, the GdViewer control prompts the user automatically with the dialog box to insert the password if the PDF to display is protected. Changing this property to False/false will force the control to use your own dialog box. Then you will have to catch the PdfPasswordRequest event to display your dialog box for entering the password.

 
Public PropertyEnables or disables the option that allows you to utilize your own dialog box requesting a certificate file if the PDF document to display is protected.

If this property is set to True/true, the GdViewer control prompts the user automatically with the dialog box to insert the file if the PDF to display is protected. Changing this property to False/false will force the control to use your own dialog box. Then you will have to catch the PdfCertificateRequest event to display your dialog box for entering the certificate file.

 
Public PropertySpecifies if the GdViewer control is responsible to check digital certificate when rendering a PDF document containing a digital signature. Depending on the outcome of the certificate audit, the visible appearance associated with each digital signature contained in the displayed document is adjusted.  
Public PropertyGets or sets the border color of the rectangle of area selection, that is related to the document currently displayed in the GdViewer control. This color is used when drawing the rectangle of selection within the control.

You can find out, if this rectangle is currently defined, using the IsRect method.

 
Public PropertyGets or sets the border size (the border width), in pixels, of the rectangle of area selection, that is related to the document currently displayed in the GdViewer control. This value is used when drawing the rectangle of selection within the control.

You can find out, if this rectangle is currently defined and drawn, using the IsRect method.

 
Public PropertyDetermines, if the rectangle of area selection can be moved or resized (edited) by a user. You are allowed to edit the rectangle using the mouse when the MouseMode property is set to GdPicture14.ViewerMouseMode.MouseModeAreaSelection.

You can find out, if this rectangle is currently defined and drawn within the GdViewer control, using the IsRect method. The rectangle of selection always relates to the document currently displayed in the GdViewer control.

 
Public PropertyDetermines if highlighted regions can be edited, that means selected, moved or resized by a user.

Highlighted regions for currently displayed document are identified and created when searching text, for example using the SearchText(String,Int32,Boolean) method or the second similar overloaded method as well. You can also define highlighted regions directly using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods.

 
Public PropertySpecifies whether the GdPicture/XMP annotations, if present, are rendered or not on the document displayed in the GdViewer control.  
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertyDetermines if the scrollbars are enabled, that means whether the scrollbars are to be displayed or not within the GdViewer control.

If this property is set to True/true, the scrollbars appear when the area to render is larger than the control. Turning this property to False/false forces both scrollbars to be always invisible, whatever the zoom configuration is.

 
Public PropertyGets or sets a value to be added to or subtracted from the current scrollbar position when the scrollbar (both horizontal or vertical) is moved a large distance.  
Public PropertyGets or sets a value to be added to or subtracted from the current scrollbar position when the scrollbar (both horizontal or vertical) is moved a small distance.  
Public PropertyIndicates, whether error reporting through MessageBox dialogue is disabled or not when loading password-protected or encrypted PDF documents. The MessageBox dialogue will display when a password is needed, when users provide an invalid password or when an encryption error occurs.

Turning this property to False/false enables error reporting through MessageBox dialogues. If this property is set to True/true, possible errors are not reported.

 
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertyGets the vertical resolution in DPI (dots per inch) of the current page of the document displayed in the GdViewer control.  
Public PropertyGets or sets the current rotation and flipping of the page view in the GdViewer control.

This property specifies how the view is rotated and flipped in the GdViewer control when displaying the page.

 
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertyReturns if the vertical scrollbar is visible, means displayed, or not in the GdViewer control.  
Public PropertyGets or sets the current zoom (magnification) factor, that is applied during the following page rendering operations in the GdViewer control. Please use the value 1 to define the 100% zoom factor, 1.5 to define 150%, 2 to define the 200% zoom factor, etc.

If the newly specified Zoom value is the same as the current Zoom value, this method does nothing.

 
Public PropertySpecifies if the document displayed in the GdViewer control is centered to the currently defined mouse position when performing any zoom action.  
Public PropertyGets the highest zoom factor (maximal zoom) which can be used for the document displayed in the GdViewer control. The value of 1 represents the 100% zoom factor, 1.5 represents 150%, 2 represents the 200% zoom factor, etc.  
Public PropertyGets or sets the current zoom mode used by the GdViewer control and refreshes the control as well.

If the newly specified ZoomMode value is the same as the current ZoomMode value, this method does nothing.

 
Public PropertyGets or sets the zoom step, that specifies the percentage of increasing or decreasing the current zoom factor when using the ZoomIN and the ZoomOUT methods. The value of 25 represents the 25% step, the value of 10 represents the 10% step, etc.  
Top
Public Methods
 NameDescription
Public MethodOverloaded. Allows users to interactively add a new connected lines (polyline) annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodAllows users to interactively add a new custom annotation using the mouse on the current page of the document displayed in the GdViewer control.

Custom annotations are identified through the ModelID identifier, which you subsequently have to use in the OnCustomAnnotationPaint event. This event renders the required annotation according to what you specify for each ModelID inside the event respecting the dimensions users will define using the mouse as well.

The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeCustom. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationCustom class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events for how to achieve this.

Be aware that the editing mode for annotations must be enabled using the SetAnnotationEditorMode method, otherwise this method will fail.

 
Public MethodOverloaded. Allows users to interactively add a new ellipse annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new embedded image annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new freehand annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new freehand highlighter annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new freehand polygon annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new line annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new line arrow annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new link annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new polygon annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new poly ruler annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new rectangle annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new rectangle highlighter annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Adds and highlights a new region on the current page of the document displayed in the GdViewer control according to what you have specified. The region is added to the list of all highlighted regions related to the displayed document.  
Public MethodOverloaded. Adds and highlights a new region on the current page of the document displayed in the GdViewer control according to what you have specified. The region is added to the list of all highlighted regions related to the displayed document.  
Public MethodOverloaded. Allows users to interactively add a new rubber stamp annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new ruler annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new sticky note annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Allows users to interactively add a new text annotation using the mouse on the current page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Returns a Color object, that represents a required color according to your specified parameters.  
Public MethodReturns a 32-bit value, that represents a color composed from a specified set of alpha, red, green and blue color components.  
Public MethodOverloaded.  (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodOverloaded. Burn, in other words flatten, the GdPicture/XMP annotations into the current page of the document displayed in the GdViewer control.  
Public MethodAsks the GdViewer control to ignore the latest request of an interactive annotation creation. In other words, the lastly added annotation is removed.

This method only works when the editing mode for annotations is enabled; otherwise, the method will fail.

 
Public MethodMoves the current page of the document displayed in the GdViewer control within the control to set the rectangle of area selection, if any is defined, in the middle of the control. You can use the IsRect method to find out, if the rectangle of selection is currently specified.  
Public MethodClears the GdViewer control, in other words, erases the displayed document from the control. This method only cleans up the displayed area of the GdViewer control, it does not close the loaded document. It also clears the rectangle of area selection, if any is defined, using the ClearRect method internally. You can display the loaded document using the Redraw method again.  
Public MethodRemoves the rectangle of area selection, which is related to the document currently displayed in the GdViewer control, and deletes the corresponding rectangle's data, which are the location point and dimensions, as well. Removing means that no rectangle of selection is defined further, with the rectangle not drawn within the control anymore. You can find out, if this rectangle is currently defined and drawn, using the IsRect method.

As said, the rectangle of selection always relates to the displayed document, so its location point and dimensions are cleared when reloading documents within the control. On the other hand, the current values of the border size and the border color properties of the rectangle do not change when reloading documents or clearing the above-specified rectangle's data.

 
Public MethodClears the last text selection made by the user in the GdViewer control, that means both the latest selected text, as well as the selected text regions, are released.  
Public MethodOverloaded. Closes the currently displayed document with or without clearing the GdViewer control according to what you have specified.  
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodTranslates the coordinates of the point located in the document area of the document currently displayed in the GdViewer control (the document space), in inches, to the coordinates of the corresponding point located in the GdViewer control area (the viewer space), in pixels. That said, the point with the coordinates (DocumentLeft, DocumentTop) inside the currently displayed page of the document matches to the point with coordinates (ViewerLeft, ViewerTop) inside the GdViewer control area.  
Public MethodTranslates the coordinates of the point located in the document area of the document currently displayed in the GdViewer control (the document space), in pixels, to the coordinates of the corresponding point located in the GdViewer control area (the viewer space), in pixels. That said, the point with the coordinates (DocumentLeft, DocumentTop) inside the currently displayed page of the document matches to the point with coordinates (ViewerLeft, ViewerTop) inside the GdViewer control area.  
Public MethodTranslates the coordinates of the point located in the GdViewer control area (the viewer space), in pixels, to the coordinates of the corresponding point located in the displayed document (the document space), in inches. That said, the point with the coordinates (ViewerLeft, ViewerTop) inside the current page displayed in the viewer area matches to the point with coordinates (DocumentLeft, DocumentTop) inside the page with the same page number in the displayed document.  
Public MethodTranslates the coordinates of the point located in the GdViewer control area (the viewer space), in pixels, to the coordinates of the corresponding point located in the displayed document (the document space), in pixels. That said, the point with the coordinates (ViewerLeft, ViewerTop) inside the current page displayed in the viewer area matches to the point with coordinates (DocumentLeft, DocumentTop) inside the page with the same page number in the displayed document.  
Public MethodCopies the content of the specified region, related to the current page of the document displayed in the GdViewer control, into the clipboard as an image. Please ensure, that specified coordinates and dimensions correspond to the actual document pages area of the currently displayed page.  
Public MethodCopies the content of the specified region, related to the current page of the document displayed in the GdViewer control, into a GdPictureImage object. Please ensure, that specified coordinates and dimensions correspond to the actual document pages area of the currently displayed page.

The method creates a new GdPictureImage object of the required area on the displayed page. The resulting image is recognizable by its unique image identifier. Please note that you have to release the created image from the memory using the ReleaseGdPictureImage method.

 
Public MethodCopies the current page, that means the content of the whole page, of the document displayed in the GdViewer control into the clipboard as an image.  
Public Method (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.MarshalByRefObject)
Public MethodRemoves a required GdPicture/XMP annotation object specified by its index related to the current page of the document displayed in the GdViewer control.

Be aware that this method only handles GdPicture/XMP annotations.

 
Public MethodDisplays the first page of the document currently loaded in the GdViewer control. You can use the CurrentPage property to determine the currently displayed page.

The PageDisplayed and the PageChanged events are raised after the page has been successfully displayed and changed.

Be aware that the SaveAnnotationsToPage method is called internally before each page change.

 
Public MethodLoads an image data stored in a System.Drawing.Bitmap object and subsequently displays the image in the GdViewer control. The document previously displayed in the control will automatically close.

The BeforeDocumentChange and the AfterDocumentChange events are raised just before and right after the image is displayed in the GdViewer control. Both events are only raised if the image has been successfully loaded.

 
Public MethodLoads a document from an array of bytes and subsequently displays it in the GdViewer control. The document previously displayed in the control will automatically close.

All document formats currently supported by the toolkit are listed here.

The BeforeDocumentChange and the AfterDocumentChange events are raised just before and right after the document is displayed in the GdViewer control. Both events are only raised if the document has been successfully loaded.

 
Public MethodLoads an image, which is currently stored in the clipboard, and then displays it in the GdViewer control. The document previously displayed in the control will automatically close.

The BeforeDocumentChange and the AfterDocumentChange events are raised just before and right after the image is displayed in the GdViewer control. Both events are only raised if the image has been successfully loaded.

 
Public MethodLoads an image from an instantiated Device Independent Bitmap (DIB) handle and then displays it in the GdViewer control. The document previously displayed in the control will automatically close.

The BeforeDocumentChange and the AfterDocumentChange events are raised just before and right after the image is displayed in the GdViewer control. Both events are only raised if the image has been successfully loaded.

 
Public MethodOverloaded. Loads documents or images from a file and subsequently displays it in the GdViewer control.  
Public MethodOverloaded. Loads a document from a file stored on a distant server using FTP transfer and subsequently displays it in the GdViewer control.  
Public MethodLoads an image represented by the unique image identifier referring to an associated GdPictureImage object and subsequently displays it in the GdViewer control. The document previously displayed in the control will automatically close.

The BeforeDocumentChange and the AfterDocumentChange events are raised just before and right after the image is displayed in the GdViewer control. Both events are only raised if the image has been successfully loaded.

 
Public MethodLoads a PDF document from the instantiated GdPicturePDF object and subsequently displays it in the GdViewer control. The document previously displayed in the control will automatically close.

The BeforeDocumentChange and the AfterDocumentChange events are raised just before and right after the document is displayed in the GdViewer control. Both events are only raised if the document has been successfully loaded.

 
Public MethodLoads an image from an instantiated Microsoft® Windows® Graphics Device Interface (GDI) handle and then displays it in the GdViewer control. The document previously displayed in the control will automatically close.

The BeforeDocumentChange and the AfterDocumentChange events are raised just before and right after the image is displayed in the GdViewer control. Both events are only raised if the image has been successfully loaded.

 
Public MethodLoads an image of an icon from an instantiated Windows handle to icon and subsequently displays the image in the GdViewer control. The document previously displayed in the control will automatically close.

The BeforeDocumentChange and the AfterDocumentChange events are raised just before and right after the image is displayed in the GdViewer control. Both events are only raised if the image has been successfully loaded.

 
Public MethodOverloaded. Loads a document from a file stored on a distant server using HTTP transfer and subsequently displays it in the GdViewer control.  
Public MethodCancels the download process previously started using the DisplayFromFTP(String,String,String) or the DisplayFromFTP(String,String,String) methods.  
Public MethodLoads a document from an instantiated IStream object according to what you have specified and subsequently displays it in the GdViewer control. The document previously displayed in the control will automatically close.

This method is especially useful for encrypted PDF documents, as you are allowed to enter a password to decrypt the document for reading its content.

All document formats currently supported by the toolkit are listed here.

The BeforeDocumentChange and the AfterDocumentChange events are raised just before and right after the document is displayed in the GdViewer control. Both events are only raised if the document has been successfully loaded.

 
Public MethodLoads a document from a file, which data are stored within a specified memory area and subsequently displays it in the GdViewer control. The document previously displayed in the control will automatically close.

All document formats currently supported by the toolkit are listed here.

The BeforeDocumentChange and the AfterDocumentChange events are raised just before and right after the document is displayed in the GdViewer control. Both events are only raised if the document has been successfully loaded.

 
Public MethodLoads an image data stored within a raw bitmap in memory area and subsequently displays the image in the GdViewer control. The document previously displayed in the control will automatically close.

The BeforeDocumentChange and the AfterDocumentChange events are raised just before and right after the document is displayed in the GdViewer control. Both events are only raised if the document has been successfully loaded.

 
Public MethodOverloaded. Loads documents or images from a Stream object and subsequently displays it in the GdViewer control.  
Public MethodLoads a document from a file, which data are stored within a string using Encoding 1252 and subsequently displays it in the GdViewer control. The document previously displayed in the control will automatically close.

All document formats currently supported by the toolkit are listed here.

The BeforeDocumentChange and the AfterDocumentChange events are raised just before and right after the document is displayed in the GdViewer control. Both events are only raised if the document has been successfully loaded.

 
Public MethodDisplays the last page of the document currently loaded in the GdViewer control. You can use the CurrentPage property to determine the currently displayed page.

The PageDisplayed and the PageChanged events are raised after the page has been successfully displayed and changed.

Be aware that the SaveAnnotationsToPage method is called internally before each page change.

 
Public MethodDisplays the next page, if any is available, of the document currently loaded in the GdViewer control. You can use the CurrentPage property to determine the currently displayed page.

The PageDisplayed and the PageChanged events are raised after the page has been successfully displayed and changed.

Be aware that the SaveAnnotationsToPage method is called internally before each page change.

 
Public MethodChanges the displayed page to the specified one, if that is available, of the document currently loaded in the GdViewer control. The value of the CurrentPage property is changed to the specified page number as well.

The PageDisplayed and the PageChanged events are raised after the page has been successfully displayed and changed.

Be aware that the SaveAnnotationsToPage method is called internally before each page change.

 
Public MethodDisplays the previous page, if any is available, of the document currently loaded in the GdViewer control. You can use the CurrentPage property to determine the currently displayed page.

The PageDisplayed and the PageChanged events are raised after the page has been successfully displayed and changed.

Be aware that the SaveAnnotationsToPage method is called internally before each page change.

 
Public MethodAllows users to modify the annotation text directly within the defined annotation rectangle area. The actual annotation content is completely selected. Please note that this method is only applicable to sticky note and text annotations.

The method can be particularly useful if you want to let users add the new text (the annotation content) of the sticky note or text annotation right after they create it. The annotation rectangle area will serve as an editable dialogue box. Please refer to the attached example how it works.

The AnnotationStartEditingText event is raised after opening the dialogue box.

 
Public MethodDisposes already used GdViewer object completely. All related resources used by this object are released.

Please note that this method implicitly calls the CloseDocument method.

 
Public Method (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodEnsures the visibility of a highlighted region within the current GdViewer control. The region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

To confirm the region visibility means that the control can change the current page or can scroll the content to ensure that the required region is fully visible.

 
Public Method (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodReturns the number of all GdPicture/XMP annotation objects contained within the current page of the document displayed in the GdViewer control.

Be aware that this method only handles GdPicture/XMP annotations.

 
Public MethodReturns a required GdPicture/XMP annotation object specified by its index related to the current page of the document displayed in the GdViewer control.

Be aware that this method only handles GdPicture/XMP annotations.

 
Public MethodGets the AnnotationManager object associated with the current GdViewer control object for direct use.

Using this object, you are allowed for example to handle annotations behind the associated GdViewer control.

 
Public MethodOverloaded.  (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodReturns coordinates and dimensions, in pixels, of the document's visible area within the control. The resulting rectangle relates to the current page of the document displayed in the GdViewer control and the coordinates correspond to the actual document pages area of the currently displayed page.  
Public MethodReturns coordinates and dimensions, in inches, of the document's visible area within the control. The resulting rectangle relates to the current page of the document displayed in the GdViewer control and the coordinates correspond to the actual document pages area of the currently displayed page.  
Public MethodReturns the horizontal (X) coordinate of the point on the current page located in the document pages area, in pixels, that matches to the point on the current page of the displayed document located exactly in the top left corner within the GdViewer control. Be aware that the resulting coordinate may be negative if the current page is shifted in the control.  
Public MethodReturns the vertical (Y) coordinate of the point on the current page located in the document pages area, in pixels, that matches to the point on the current page of the displayed document located exactly in the top left corner within the GdViewer control. Be aware that the resulting coordinate may be negative if the current page is shifted in the control.  
Public MethodReturns the type of the document currently displayed in the GdViewer control.  
Public MethodReturns the handle to the device context associated with this GdViewer control.  
Public MethodGets a maximum available position of the horizontal scrollbar, in pixels, related to the document currently displayed in the GdViewer control. That said, it is a maximum coordinate on the horizontal axis, which the horizontal scrollbar can reach on the displayed document according to the current control settings.  
Public MethodGets the current position of the horizontal scrollbar, in pixels, related to the document currently displayed in the GdViewer control. The resulting coordinate corresponds to the actual document area of the currently displayed page.  
Public MethodReturns the file path of the latest loaded or saved file using this GdViewer control. The stored value is not erased after closing the file. It is only overwritten with each new file loading or saving operation.

Be aware that both AddEmbeddedImageAnnotInteractive(String,Boolean,Color,Single,Single) and AddEmbeddedImageAnnotInteractive(String,Boolean,Int32,Single,Single) methods overwrite the last used path with their ImagePath parameter.

 
Public MethodReturns the error description of the last executed HTTP or FTP transfer operation with this GdViewer control, if that has failed specifically with one of the GdPictureStatus.Internet... errors.  
Public Method (Inherited from System.MarshalByRefObject)
Public MethodReturns the horizontal (X) coordinate (0-based) of the mouse cursor position located in the document area, in pixels, related to the current page of the displayed document in the GdViewer control.  
Public MethodReturns the vertical (Y) coordinate (0-based) of the mouse cursor position located in the document area, in pixels, related to the current page of the displayed document in the GdViewer control.  
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodOverloaded. Returns the whole text of the specified page of the document displayed in the GdViewer control.  
Public MethodOverloaded. Returns the text, that is contained within a specific area of the page of the text-based document displayed in the GdViewer control.  
Public MethodOverloaded. Creates a custom sized high quality (HQ) thumbnail of the selected page of the document displayed in the GdViewer control according to what you have specified. The required page is converted to an image resource and stored as an object of the type GdPictureImage.  
Public MethodCreates a custom sized high quality (HQ) thumbnail of the specified page of the document displayed in the GdViewer control as a bitmap. The required page is converted to an image thumbnail that fits within a rectangle of the size and the background color you have specified.  
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodGets data of the currently defined rectangle of area selection refering to the document pages area. This method gets the rectangle's coordinates and dimensions, in pixels, which determine the rectangle of selection related to the document displayed in the GdViewer control. The resulting values correspond to the actual document pages area.

Be aware that the rectangle of selection always relates to the displayed document. You can find out, if this rectangle is defined and drawn, using the IsRect method.

 
Public MethodGets data of the currently defined rectangle of area selection refering to the document pages area. This method gets the rectangle's coordinates and dimensions, in inches, which determine the rectangle of selection related to the document displayed in the GdViewer control. The resulting values correspond to the actual document pages area.

Be aware that the rectangle of selection always relates to the displayed document. You can find out, if this rectangle is defined and drawn, using the IsRect method.

 
Public MethodGets data of the currently defined rectangle of area selection refering to the displayed viewer area. This method gets the rectangle's coordinates and dimensions, in pixels, which determine the rectangle of selection related to the document displayed in the GdViewer control. The resulting values correspond to the actual viewer area.

Be aware that the rectangle of selection always relates to the displayed document. You can find out, if this rectangle is defined and drawn, using the IsRect method.

 
Public MethodReturns the height, in pixels, of the rectangle of area selection, related to the current page. The resulting value corresponds to the actual document pages area of the document displayed in the GdViewer control. You can determine, if the rectangle of selection is currently defined and drawn within the control, using the IsRect method.  
Public MethodReturns the height, in pixels, of the rectangle of area selection, related to the document displayed in the GdViewer control. The resulting value corresponds to the viewer area. You can determine, if the rectangle of selection is currently defined and drawn within the control, using the IsRect method.  
Public MethodReturns the horizontal (X) coordinate (0-based) of the top left point, in pixels, of the rectangle of area selection, related to the current page. The resulting coordinate corresponds to the actual document pages area of the document displayed in the GdViewer control. You can determine, if the rectangle of selection is currently defined and drawn within the control, using the IsRect method.  
Public MethodReturns the horizontal (X) coordinate (0-based) of the top left point, in pixels, of the rectangle of area selection, related to the document displayed in the GdViewer control. The resulting coordinate corresponds to the viewer area. You can determine, if the rectangle of selection is currently defined and drawn within the control, using the IsRect method.  
Public MethodReturns the vertical (Y) coordinate (0-based) of the top left point, in pixels, of the rectangle of area selection, related to the current page. The resulting coordinate corresponds to the actual document pages area of the document displayed in the GdViewer control. You can determine, if the rectangle of selection is currently defined and drawn within the control, using the IsRect method.  
Public MethodReturns the vertical (Y) coordinate (0-based) of the top left point, in pixels, of the rectangle of area selection, related to the document displayed in the GdViewer control. The resulting coordinate corresponds to the viewer area. You can determine, if the rectangle of selection is currently defined and drawn within the control, using the IsRect method.  
Public MethodReturns the width, in pixels, of the rectangle of area selection, related to the current page. The resulting value corresponds to the actual document pages area of the document displayed in the GdViewer control. You can determine, if the rectangle of selection is currently defined and drawn within the control, using the IsRect method.  
Public MethodReturns the width, in pixels, of the rectangle of area selection, related to the document displayed in the GdViewer control. The resulting value corresponds to the viewer area. You can determine, if the rectangle of selection is currently defined and drawn within the control, using the IsRect method.  
Public MethodGets the border color of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the border color of each highlighted region using the SetRegionBorderColor(Int32,Color) method.

 
Public MethodGets the border width, in inches, of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the border width of each highlighted region using the SetRegionBorderWidth method.

 
Public MethodGets the fill color of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the fill color of each highlighted region when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods or directly using the SetRegionColor(Int32,Color) method.

 
Public MethodGets the fill color of a highlighted region, when it is selected by the user. The region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define this color of each highlighted region using the SetRegionColorSelection(Int32,Color) method.

 
Public MethodGets the height of the highlighted region's rectangle, in inches, related to the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the height of the region's rectangle when adding regions using using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods or directly using the SetRegionHeight method.

 
Public MethodGets the height of the highlighted region's rectangle, in pixels, related to the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the height of the region's rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) method or directly using the SetRegionHeightPixels method.

 
Public MethodReturns the unique region identifier of a highlighted region specified by its sequence index related to the document currently displayed in the GdViewer control. You always have to apply this identifier when working with highlighted regions.

These regions, if present, determines the currently defined highlighted regions on the displayed document.

 
Public MethodGets the horizontal (X) coordinate of the top left point, in inches, where the highlighted region's rectangle is located on the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define this coordinate of the region'rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods or directly using the SetRegionLeft method.

 
Public MethodGets the horizontal (X) coordinate of the top left point, in pixels, where the highlighted region's rectangle is located on the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define this coordinate of the region'rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods or directly using the SetRegionLeftPixels method.

 
Public MethodGets the foreground mix mode of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

The foreground mix mode is used to combine the region fill color and the displayed area of the image covered by this region when highlighting. You can define this parameter of each highlighted region when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods or directly using the SetRegionMixMode method.

 
Public MethodGets the name of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the name of each highlighted region when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods or directly using the SetRegionName method.

 
Public MethodGets the number of the page on which a highlighted region is drawn (placed). The region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can redefine the page of each highlighted region using the SetRegionPage method.

 
Public MethodGets the selection status of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

To select a region means that the region is visibly marked on the page with the thin red border, so its selection status is set to True/true. You can change the selection of each highlighted region using the SetRegionSelected method.

You can also benefit from using the RegionSelectedByUser event.

 
Public MethodGets the vertical (Y) coordinate of the top left point, in inches, where the highlighted region's rectangle is located on the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define this coordinate of the region's rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods or directly using the SetRegionTop method.

 
Public MethodGets the vertical (Y) coordinate of the top left point, in pixels, where the highlighted region's rectangle is located on the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define this coordinate of the region'rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods or directly using the SetRegionTopPixels method.

 
Public MethodGets the width of the highlighted region's rectangle, in inches, related to the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the width of the region's rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods or directly using the SetRegionWidth method.

 
Public MethodGets the width of the highlighted region's rectangle, in pixels, related to the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the width of the region's rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods or directly using the SetRegionWidthPixels method.

 
Public MethodReturns an index of the selected GdPicture/XMP annotation object within the current page of the document displayed in the GdViewer control.

Be aware that this method only handles GdPicture/XMP annotations. Likewise, annotations are always treated relative to the currently displayed page.

 
Public MethodReturns the last text selected by the user. This text is stored until you call the ClearSelectedText method to release it.  
Public MethodReturns all rectangle areas, related to the current page, that represent the regions bounding the last text selected by the user. Each region is defined by its top left coordinates and by its width and height expressed in inches. These regions are stored until you call the ClearSelectedText method to release them.  
Public MethodReturns the status of the last executed operation with this GdViewer control.  
Public MethodOverloaded. Searches for an occurrence of a given text expression within the specified page of the document displayed in the GdViewer control according to the parameters you have specified. You can select either the Ordinal or the InvariantCulture comparison when searching.  
Public MethodReturns the GdPicture source code version you are currently using. The format of the returned value is M.mrr, where 'M' describes the major version of the product, 'm' is the medium version and 'rr' is the release number of the current version.

Please find the version history page of the GdPicture.NET toolkit here.

 
Public MethodGets a maximum available position of the vertical scrollbar, in pixels, related to the document currently displayed in the GdViewer control. That said, it is a maximum coordinate on the vertical axis, which the vertical scrollbar can reach on the displayed document according to the current control settings.  
Public MethodGets the current position of the vertical scrollbar, in pixels, related to the document currently displayed in the GdViewer control. The resulting coordinate corresponds to the actual document area of the currently displayed page.  
Public MethodPlays a GIF animation referring to the file displayed in the GdViewer control in a loop.  
Public MethodStops the currently played GIF animation referring to the file displayed in the GdViewer control.  
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodTerminates the editing mode for modifying the annotation text within its rectangle area. You can specify if the defined text will be saved to the related annotation.

The annotation rectangle area previously enabled for editing by DisplayTextEditBox method will be disabled. If the editable dialogue box is not displayed, this method will fail.

The AnnotationEndEditingText event is raised after closing the dialogue box.

 
Public Method (Inherited from System.MarshalByRefObject)
Public MethodOverloaded.  (Inherited from System.Windows.Forms.Control)
Public MethodOverloaded.  (Inherited from System.Windows.Forms.Control)
Public MethodReturns the total number of IPTC tags embedded within the document displayed in the GdViewer control. These tags, also known as document's metadata, allows for additional information to be stored within a document.  
Public MethodReturns a unique IPTC tag ID (a proper IPTC tag name defined by the specification) of the required tag, that is embedded within the document displayed in the GdViewer control.  
Public MethodReturns a string representation of the current tag value of the required IPTC tag, that is embedded within the document displayed in the GdViewer control.  
Public MethodIndicates, whether the specified point related to the current GdViewer control space, is contained within the bounding box of the annotation specified by its index. The coordinates of the required point, in pixels, relates to the current control space and the specified annotation relates to the currently displayed page of the document loaded in the GdViewer control.

Be aware that this method only handles GdPicture/XMP annotations.

 
Public MethodDetects, if the rectangle of area selection is drawn within the GdViewer control, which means this rectangle is defined. Please note that the rectangle of selection always relates to the document currently displayed in the GdViewer control.

The rectangle of area selection is determined using both SearchText(String,Int32,Boolean) and SearchText(String,Int32,Boolean,Boolean) methods, when setting the Occurrence parameter higher than 0. Hovewer, you can also define the custom rectangle of selection using one of these methods: SetRectCoordinatesOnDocument , SetRectCoordinatesOnDocumentInches and SetRectCoordinatesOnViewer.

You can use the CenterOnRect method to make the rectangle visible, if any is defined, or the ClearRect method to clear the rectangle's location point and dimensions.

 
Public MethodDetects, if the user is drawing the rectangle of area selection.

Please note that the rectangle of selection always relates to the document currently displayed in the GdViewer control. You can find out, if this rectangle is currently defined and drawn within the control, using the IsRect method.

The RectEditedByUser event is raised when the rectangle has been successfully drawn.  
Public MethodDetects, if the user is moving or editing the rectangle of area selection.

Please note that the rectangle of selection always relates to the document currently displayed in the GdViewer control. You can find out, if this rectangle is currently defined and drawn within the control, using the IsRect method.

The RectEditedByUser event is raised when the rectangle has been successfully edited.  
Public MethodOverloaded. Loads the GdPicture/XMP annotations from a properly formatted file or stream and subsequently applies them to the document currently displayed in the GdViewer control.  
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodReturns the author of the currently displayed PDF document, if any is set in the document information dictionary. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public MethodReturns the date and time, when the currently displayed PDF document was created, as it is set in the document information dictionary. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public MethodReturns the creator of the currently displayed PDF document, if any is set in the document information dictionary. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public MethodReturns the encryption algorithm which has been used to encrypt the currently displayed PDF document. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public MethodReturns the keywords of the currently displayed PDF document, if any is set in the document information dictionary. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public MethodReturns the metadata of the currently displayed PDF document, if any are stored in the PDF. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public MethodReturns the date and time, when the currently displayed PDF document was most recently modified, as it is set in the document information dictionary. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public MethodReturns the page height in PDF point units of the currently selected page in the displayed PDF document. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public MethodReturns the page width in PDF point units of the currently selected page in the displayed PDF document. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public MethodReturns the producer of the currently displayed PDF document, if any is set in the document information dictionary. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public MethodReturns the subject of the currently displayed PDF document, if any is set in the document information dictionary. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public MethodReturns the title of the currently displayed PDF document, if any is set in the document information dictionary. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public MethodReturns the version of the PDF specification to which the currently displayed PDF document conforms. If the document currently displayed in the GdViewer control is not the PDF file, the method will fail.  
Public Method (Inherited from System.Windows.Forms.ContainerControl)
Public MethodOverloaded.  (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodOverloaded. Prints the document currently displayed in the GdViewer control to the active printer.  
Public MethodOverloaded. Invokes the standard Windows Print dialog box allowing you to print the displayed document by selecting additional settings.  
Public MethodReturns the name of the printer, that is currently selected as the active printer, means the printer, which is subsequently used when printing the document displayed in the GdViewer control.

It is mostly the default printer, if not set otherwise. Hovewer, you can use the PrintSetActivePrinter method to select your preferred printer for next print jobs without affecting any other installed printers.

 
Public MethodReturns the value of an image alignment setting of the active printer. This value determines how the image is aligned when printing.  
Public MethodReturns the printer collate setting of the active printer. This property determines, whether the printed document is collated.

True/true will print a complete copy of the document before the first page of the next copy is printed. False/false will print each page by the number of copies specified before printing the next page.

 
Public MethodReturns the printer color mode setting of the active printer. This property determines whether the output will print in color or in monochrome.  
Public MethodReturns the printer copies setting of the active printer, that means the number of copies to be printed.  
Public MethodReturns the printer document name setting of the active printer. You can use it to display during the next print process (for example, in a print status dialog box or printer queue) while printing the document.  
Public MethodReturns the printer duplex mode setting of the active printer. This property determines whether a page is printed on both sides (if the printer supports this feature).  
Public MethodReturns the error description of the last executed print operation, that has failed specifically with the GdPictureStatus.PrintingException error.  
Public MethodReturns the physical margins (x and y coordinates), that are part of the default page settings property of the active printer. Both margins are used as defaults for all pages to be printed.  
Public MethodReturns the printer orientation setting of the active printer. This property determines the page orientation when printing.  
Public MethodReturns the paper source, means the paper tray, from which the printer gets paper, used by the active printer. The value is determined through the PaperSource.Kind property of the default page settings.  
Public MethodReturns the height of the paper to be used by the active printer.  
Public MethodReturns the current paper size, means the type of the paper, to be used by the active printer. The value is determined through the PaperSize.Kind property of the default page settings.  
Public MethodReturns the width of the paper to be used by the active printer.  
Public MethodReturns the name of the printer according to the index you have specified.

You can use the PrintGetPrintersCount method to determine the number of all available printers. The printer index is simply an integer value from 1 to PrintGetPrintersCount.

 
Public MethodReturns the number of all available (installed) printers on the computer.  
Public MethodReturns the printer settings of the active printer.

As explained in the PrintGetActivePrinter or the PrintSetActivePrinter methods, none of the available printers or their properties are affected using any of the print methods of this class.

 
Public MethodReturns the printer quality setting of the active printer. This setting matches the PrinterResolutionKind property included in the PrinterSettings.PrinterResolutions parameter of the active printer.  
Public MethodReturns the status of the last executed print operation with the current GdViewer control.

If the returned status is specifically GdPictureStatus.PrintingException, you can use the PrintGetLastError method to find out more details.

 
Public MethodSets the printer, identified by its name, as the active printer, in other words makes it the currently selected printer, which is subsequently used when printing the document displayed in the GdViewer control. The specified printer is used to execute all next print jobs using the print methods of this class, if not set otherwise, without affecting any other installed printers.

You can use the PrintGetActivePrinter method to retrieve the currently selected printer, denoted as the active printer for print methods of this class. At the same this printer utilizes all by you altered printer settings without affecting the installed printers.

 
Public MethodSets up the value of an image alignment setting of the active printer. This value determines how the image is aligned when printing.  
Public MethodSets up the auto-rotation property of the active printer, that determines, if the pages are automatically rotated to fit on the output medium when printing.  
Public MethodSets up the printer collate setting of the active printer. This property determines, whether the printed document is collated.

Setting it to True/true will print a complete copy of the document before the first page of the next copy is printed. Setting it to False/false will print each page by the number of copies specified before printing the next page.

 
Public MethodSets up the printer color mode setting of the active printer. This property determines whether the output will print in color or in monochrome.  
Public MethodSets up the printer copies setting of the active printer, that means the number of copies to be printed.  
Public MethodSets up the printer document name setting of the active printer. You can use it to display during the next print process (for example, in a print status dialog box or printer queue) while printing the document.  
Public MethodSets up the printer duplex mode setting of the active printer. This property determines whether a page is printed on both sides (if the printer supports this feature).  
Public MethodSets up the required range of pages you want to print during the next print process using the active printer.  
Public MethodSets up the printer orientation setting of the active printer. This property determines the page orientation when printing.  
Public MethodSets up the required selection of pages you want to print during the next print process using the active printer.

The specified pages selection will not take into account if you will print using the PrintDialog method.

 
Public MethodOverloaded. Sets up the paper source, from which the active printer gets paper.  
Public MethodSets the paper size, means the type of the paper, to be used by the active printer.  
Public MethodEnables or disables the pre-rasterization parameter which specifies whether the pages of the document currently displayed in the GdViewer control must be pre-rasterized before being printed using the active printer. Enabling the pre-rasterization can dramatically improve the performance with printer drivers non-optimized for vector graphics rendering.  
Public MethodSets up the printer settings of the active printer.

As explained in the PrintGetActivePrinter or the PrintSetActivePrinter methods, none of the available printers or their properties are affected using any of the print methods of this class.

 
Public MethodSets up the printer quality setting of the active printer. This setting matches the PrinterResolutionKind property included in the PrinterSettings.PrinterResolutions parameter of the active printer.

If the required Quality parameter is identified within the set of PrinterSettings.PrinterResolutions property items of the active printer, then the currently defined active printer resolution is filled up with the specified resolution attributes provided by the corresponding printer resolution item.

 
Public MethodEnables or disables showing the progress indicator during the print process. The printing progress bar is displayed by default.  
Public MethodSets up the standard paper size, means the type of the paper, to be used by the active printer.  
Public MethodSets up a custom paper size to be used by the active printer.  
Public MethodOverloaded. Prompts the printer driver to show the printer settings dialog box of the active printer.  
Public Method (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodRedraws the displayed document within the GdViewer control, that means refresh the displayed area of the control to show the currently loaded document, if any is defined.  
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodReturns the number of all highlighted regions related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define a highlighted region using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods. Be aware that highlighted regions are also determined using both SearchText(String,Int32,Boolean) and SearchText(String,Int32,Boolean,Boolean) methods.

 
Public MethodReleases a specified image and its corresponding image resource from memory.  
Public MethodReleases the handle to the device context associated with this GdViewer control, which has been obtained by a previous call of the GetHdc method.  
Public MethodForces the control to reload all GdPicture/XMP annotations contained within the currently displayed page of the document loaded in the GdViewer control.

We recommend to only use this method if the currently displayed document has been edited by another object. Afterwards, you need to call the Redraw method to refresh the control for displaying all required changes.

 
Public MethodRemoves all highlighted regions related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define a highlighted region using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods. Be aware that highlighted regions are also determined using both SearchText(String,Int32,Boolean) and SearchText(String,Int32,Boolean,Boolean) methods.

 
Public MethodRemoves the specified contextual menu item. The available menu items are listed below.

The context menu is only available if some document is displayed in the GdViewer control. Please note that the toolkit does not support adding custom menu items right now.

You can control displaying the menu in the GdViewer control by using the EnableMenu property.

 
Public MethodRemoves a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.  
Public MethodRemoves a highlighted region specified by its name related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.  
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodOverloaded.  (Inherited from System.Windows.Forms.Control)
Public MethodRotates clockwise or flips the current page of the document displayed in the GdViewer control. The rotation angle can be set to 0, 90, 180 or 270 degrees clockwise and you are allowed to specify the axis used to flip the page.

The BeforeRotation event is raised just before the rotation process starts and the Rotation event is raised right after the rotation process finishes.

Be aware that the page is only rotated in the control, not in the document itself. Files are always handled as read-only in the GdViewer control.

 
Public MethodRotates clockwise by a specified angle all GdPicture/XMP annotations contained within the currently displayed page of the document loaded in the GdViewer control. The coordinate system of the current page is used to determine the rotation direction.

Be aware that annotations are always treated relative to the currently displayed page.

Please note that you need to call the Redraw method after the successful rotation to refresh the control for displaying all applied changes.

 
Public MethodRotates clockwise or flips the global view of this GdViewer control. The rotation angle can be set to 0, 90, 180 or 270 degrees clockwise and you are allowed to specify the axis used to flip the view.

The BeforeRotation event is raised just before the rotation process starts and the Rotation event is raised right after the rotation process finishes.

 
Public MethodForces the GdViewer control to save GdPicture/XMP annotations to the current page defined by the CurrentPage property, of the document displayed in the GdViewer control. Be aware that annotations are always treated relative to the currently displayed page.

This method only attaches rendered annotations to the current page while keeping them in the GdPicture/XMP format. You need to use the BurnAnnotationsToPage(Boolean) method to permanently include them into the page content.

Please note that this method is applied internally automatically on each page change.

 
Public MethodOverloaded. Saves the GdPicture/XMP annotation part of the current page of the document displayed in the GdViewer control in XML format to a file or to a stream.  
Public MethodOverloaded. Saves the GdPicture/XMP annotation part of all pages of the document displayed in the GdViewer control in XML format to a file or to a stream.  
Public MethodOverloaded. Saves the document displayed in the GdViewer control to a file in JPEG format with full GdPicture XMP annotation suppport.  
Public MethodOverloaded. Saves the document displayed in the GdViewer control to a file in PDF format with full GdPicture XMP annotation suppport.  
Public MethodOverloaded. Saves the document displayed in the GdViewer control to a file in TIFF format with full GdPicture XMP annotation suppport.  
Public Method (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.ScrollableControl)
Public MethodOverloaded. Searches for an occurrence of a given text expression within the defined page of the document displayed in the GdViewer control according to the specified parameters and highlights the result or returns its coordinates. You can select either the Ordinal or the InvariantCulture comparison when searching.  
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodSelects all text on the currently displayed page of the text-based document in the GdViewer control. Be aware that text selection is only enabled if the EnableTextSelection property is set to True/true.  
Public MethodSelects a required GdPicture/XMP annotation object specified by its index related to the current page of the document displayed in the GdViewer control.

Be aware that this method only handles GdPicture/XMP annotations.

 
Public Method (Inherited from System.Windows.Forms.Control)
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodTurns on or off the "editing mode" for the GdPicture/XMP annotation support, that means allows to edit or to lock available GdPicture/XMP annotations of the document displayed in the GdViewer control. The initial value is set to True/true.  
Public Method (Inherited from System.Windows.Forms.ScrollableControl)
Public MethodSets the background color of this GdViewer control.  
Public MethodOverloaded.  (Inherited from System.Windows.Forms.Control)
Public MethodSpecifies if the FTP transfer mode used by DisplayFromFTP(String,String,String) method is Passive or not. The initial value is True/true.  
Public MethodSets the required position of the horizontal scrollbar, in pixels, related to the document currently displayed in the GdViewer control. In other words, the horizontal scrollbar moves to the newly specified coordinate on the horizontal axis. This coordinate relates to the actual document area of the currently displayed page.

The ScrollViewer event is raised if the scrollbar has moved.

 
Public MethodChanges the packet size used for transferring data by the DisplayFromHTTP(String,String,Int32) and DisplayFromFTP(String,String,String) methods. The initial value is 4096.  
Public MethodSets the required position of both the horizontal and the vertical scrollbars in one step, in other words, both scrollbars move to the newly specified coordinates. The coordinates are expressed in pixels and they are related to the actual document area of the currently displayed page of the document displayed in the GdViewer control.  
Public MethodChanges the caption of the specified contextual menu item. The available menu items are listed below.

The context menu is only available if some document is displayed in the GdViewer control. Please note that the toolkit does not support adding custom menu items right now.

You can control displaying the menu in the GdViewer control by using the EnableMenu property.

 
Public MethodEnables or disables the specified contextual menu item. The available menu items are listed below.

The context menu is only available if some document is displayed in the GdViewer control. Please note that the toolkit does not support adding custom menu items right now.

You can control displaying the menu in the GdViewer control by using the EnableMenu property.

 
Public MethodSets the border color of the rectangle of area selection, that is related to the document currently displayed in the GdViewer control. This color is used when drawing the rectangle of selection within the control. You can find out, if this rectangle is currently defined and drawn, using the IsRect method.

The default border color of the rectangle of area selection set by the toolkit is Color.Black. This property does not change its value when reloading documents within the control.

 
Public MethodDetermines the rectangle of area selection refering to the document pages area. This method sets the specified coordinates and dimensions, in pixels, to identify the rectangle of selection related to the the document displayed in the GdViewer control. The specified rectangle is immediately drawn on the displayed page using the predefined parameters. Please ensure, that all given values correspond to the actual document pages area.

Be aware that the rectangle of selection always relates to the displayed document. On the other hand, you can specify the border size of this rectangle using the RectBorderSize property and the border color of this rectangle using the RectBorderColor property to be applied permanently.

 
Public MethodDetermines the rectangle of area selection refering to the document pages area. This method sets the specified coordinates and dimensions, in inches, to identify the rectangle of selection related to the document displayed in the GdViewer control. The specified rectangle is immediately drawn on the displayed page using the predefined parameters. Please ensure, that all given values correspond to the actual document pages area.

Be aware that the rectangle of selection always relates to the displayed document. On the other hand, you can specify the border size of this rectangle using the RectBorderSize property and the border color of this rectangle using the RectBorderColor property to be applied permanently.

 
Public MethodDetermines the rectangle of area selection refering to the displayed viewer area. This method sets the specified coordinates and dimensions, in pixels, to identify the rectangle of selection related to the document displayed in the GdViewer control. The specified rectangle is immediately drawn on the viewer area using the predefined parameters. Please ensure, that all given values correspond to the viewer area.

Be aware that the rectangle of selection always relates to the displayed document. On the other hand, you can specify the border size of this rectangle using the RectBorderSize property and the border color of this rectangle using the RectBorderColor property to be applied permanently.

 
Public MethodOverloaded. Sets the border color of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control.  
Public MethodSets the border width, in inches, of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can determine the border width of each highlighted region using the GetRegionBorderWidth method.

 
Public MethodOverloaded. Sets the fill color of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control.  
Public MethodOverloaded. Sets the fill color of a highlighted region, when it is selected by the user. The region is specified by its unique identifier related to the document currently displayed in the GdViewer control.  
Public MethodSpecifies if users can edit a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

All newly added regions are editable by default. You can change this behaviour for all regions at once by setting the RegionsAreEditable property.

You can also benefit from using several events related to highlighted regions like RegionEditedByUser, RegionMovedByUser , RegionResizedByUser and RegionSelectedByUser.

 
Public MethodSets the height of the highlighted region's rectangle, in inches, related to the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the height of the region's rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) method. You can determine the height of the region's rectangle using the GetRegionHeight method.

 
Public MethodSets the height of the highlighted region's rectangle, in pixels, related to the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the height of the region's rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) method. You can determine the height of the region's rectangle using the GetRegionHeightPixels method.

 
Public MethodSets the horizontal (X) coordinate of the top left point, in inches, where the highlighted region's rectangle is to be located on the displayed document. The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define this coordinate of the region's rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) method. You can determine this coordinate of the region's rectangle using the GetRegionLeft method.

 
Public MethodSets the horizontal (X) coordinate of the top left point, in pixels, where the highlighted region's rectangle is to be located on the displayed document. The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define this coordinate of region's rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods. You can determine this coordinate of the region's rectangle using the GetRegionLeftPixels method.

 
Public MethodSets the foreground mix mode of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

The foreground mix mode is used to combine the region fill color and the displayed area of the image covered by this region when highlighting. You can define this parameter of each highlighted region when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods. You can determine this parameter of each highlighted region using the GetRegionMixMode method.

 
Public MethodSets the name of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the name of each highlighted region when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods. You can determine the name of each highlighted region using the GetRegionName method.

 
Public MethodSets the number of the page on which a highlighted region is to be drawn (placed). The region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can determine the page of each highlighted region using the GetRegionPage method.

 
Public MethodSets the selection status of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

To select a region means that the region is visibly marked on the page with the thin red border, so its selection status is set to True/true. You can determine the selection of each highlighted region using the GetRegionSelected method.

You can also benefit from using the RegionSelectedByUser event.

 
Public MethodSets the vertical (Y) coordinate of the top left point, in inches, where the highlighted region's rectangle is to be located on the displayed document. The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define this coordinate of the region'rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods. You can determine this coordinate of the region's rectangle using the GetRegionTop method.

 
Public MethodSets the vertical (Y) coordinate of the top left point, in pixels, where the highlighted region's rectangle is to be located on the displayed document. The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define this coordinate of the region's rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods. You can determine this coordinate of the region's rectangle using the GetRegionTopPixels method.

 
Public MethodSets the width of the highlighted highlighted region's rectangle, in inches, related to the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the width of the region's rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods. You can determine the width of the region's rectangle using the GetRegionWidth method.

 
Public MethodSets the width of the highlighted region's rectangle, in pixels, related to the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the width of the region's rectangle when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods. You can determine the width of the region's rectangle using the GetRegionWidthPixels method.

 
Public MethodSets the required position of the vertical scrollbar, in pixels, related to the document currently displayed in the GdViewer control. In other words, the vertical scrollbar moves to the newly specified coordinate on the vertical axis. This coordinate relates to the actual document area of the currently displayed page.

The ScrollViewer event is raised if the scrollbar has moved.

 
Public MethodAdjusts the zoom (magnification) factor to be the 100% of the document displayed in the GdViewer control, in other words sets the current zoom factor to display the 100% of the loaded document.

This method sets the ZoomMode property to ViewerZoomMode.ZoomMode100 and refreshes the control as well.

 
Public MethodFits the document currently displayed in the GdViewer control to the viewer area while keeping the aspect ratio.

This method sets the ZoomMode property to ViewerZoomMode.ZoomModeFitToViewer and refreshes the control as well.

 
Public MethodFits the document currently displayed in the GdViewer control to the current height of the viewer area, in other words the document is zoomed to fit the viewer's height.

This method sets the ZoomMode property to ViewerZoomMode.ZoomModeHeightViewer and refreshes the control as well.

 
Public MethodShrinks the document currently displayed in the GdViewer control to the current width of the viewer area.

This method sets the ZoomMode property to ViewerZoomMode.ZoomModeShrinkToViewerWidth and refreshes the control as well.

 
Public MethodFits the document currently displayed in the GdViewer control to the current area of the control. The document is zoomed to fit the entire viewer area without keeping the aspect ratio.

This method sets the ZoomMode property to ViewerZoomMode.ZoomModeToViewer and refreshes the viewer as well.

 
Public MethodFits the document currently displayed in the GdViewer control to the current width of the viewer area, in other words the document is zoomed to fit the viewer's width.

This method sets the ZoomMode property to ViewerZoomMode.ZoomModeWidthViewer and refreshes the control as well.

 
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodUsed for GdPicture technical support purpose.  
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodReturns the total number of tags (EXIF, IPTC, Extra, Thumbnails & GPS, XML packet) embedded within the document displayed in the GdViewer control. These tags, also known as document's metadata, allows for additional information to be stored within a document.  
Public MethodReturns a unique tag ID (a proper tag name defined by the specification) of the required tag, that is embedded within the document displayed in the GdViewer control.  
Public MethodReturns a string representation of a unique predefined tag name of the required tag, that is embedded within the document displayed in the GdViewer control.  
Public MethodReturns a string representation of the current tag value of the required tag, that is embedded within the document displayed in the GdViewer control.  
Public Method (Inherited from System.ComponentModel.Component)
Public Method (Inherited from System.Windows.Forms.Control)
Public MethodOverloaded.  (Inherited from System.Windows.Forms.ContainerControl)
Public MethodOverloaded.  (Inherited from System.Windows.Forms.UserControl)
Public MethodAdjusts the current zoom to the area covered by the specified rectangle on the current page of the document displayed in the GdViewer control. The control is subsequently refreshed to zoom on the defined area.

You can try the Document Viewer Sample here to find out, how to utilize zooming features in your application.

 
Public MethodIncreases the current zoom level, it means zooms in on the control. You can use ZoomStep property to determine or to reset the currently used zoom step.

This method sets the ZoomMode property to ViewerZoomMode.ZoomModeCustom and refreshes the control as well.

 
Public MethodDecreases the current zoom level, it means zooms out on the control. You can use ZoomStep property to determine or to reset the currently used zoom step.

This method sets the ZoomMode property to ViewerZoomMode.ZoomModeCustom and refreshes the control as well.

 
Public MethodAdjusts the current zoom to the area covered by the specified rectangle of area selection. You can use the IsRect method to determine if any rectangle of selection is defined.

The control is subsequently refreshed to zoom on the determined rectangle.

 
Top
Public Events
 NameDescription
Public EventThis event is raised right after the new document has been successfully loaded and displayed in the GdViewer control using one of the DisplayFrom... methods.

Please check the corresponded GdViewer.AfterDocumentChangeEventHandler for more details.

 
Public EventThis event is raised right after a page has been successfully printed through the GdViewer control using one of the Print or PrintDialog methods.

Please check the corresponded GdViewer.AfterPrintPageEventHandler for given parameters.

 
Public EventThis event is raised after the zoom level has been successfully changed.

Please check the corresponded GdViewer.AfterZoomChangeEventHandler for more details.

 
Public EventThis event is raised right after a new GdPicture/XMP annotation has been added by a user. This event occurs in the mouse up action.

Please check the corresponded GdViewer.AnnotationAddedByUserEventHandler for given parameters.

 
Public EventThis event is raised when a GdPicture/XMP annotation has been clicked. This event occurs in the mouse down action.

Please check the corresponded GdViewer.AnnotationClickedEventHandler for given parameters.

 
Public EventThis event is raised when the user has finished editing the content of the sticky note or text GdPicture/XMP annotations by leaving the editable dialogue box.

Please check the corresponded GdViewer.AnnotationEndEditingTextEventHandler for given parameters.

 
Public EventThis event is raised right after a GdPicture/XMP annotation has been moved by a user.

Please check the corresponded GdViewer.AnnotationMovedEventHandler for given parameters.

 
Public EventThis event is raised right after a GdPicture/XMP annotation has been resized by a user.

Please check the corresponded GdViewer.AnnotationResizedEventHandler for given parameters.

 
Public EventThis event is raised right after a GdPicture/XMP annotation has been rotated by a user.

Please check the corresponded GdViewer.AnnotationRotatedEventHandler for given parameters.

 
Public EventThis event is raised when a GdPicture/XMP annotation has been selected or deselected.

Please check the corresponded GdViewer.AnnotationSelectedEventHandler for given parameters.

 
Public EventThis event is raised when the user starts editing the content of the sticky note or text GdPicture/XMP annotations by double click on the concerned annotation.

Please check the corresponded GdViewer.AnnotationStartEditingTextEventHandler for given parameters.

 
Public Event (Inherited from System.Windows.Forms.UserControl)
Public Event (Inherited from System.Windows.Forms.UserControl)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public EventThis event is raised right before a new GdPicture/XMP annotation is to be added by a user. This event occurs in the mouse down action, therefore it allows you to change some properties of the newly added annotation before rendering it on the screen.

Please check the corresponded GdViewer.BeforeAnnotationAddedByUserEventHandler for given parameters.

 
Public EventThis event is raised right before the new document is displayed (changed) after the successful loading in the GdViewer control using one of the DisplayFrom... methods.

Please check the corresponded GdViewer.BeforeDocumentChangeEventHandler for more details.

 
Public EventThis event is raised right before a page is to be printed through the GdViewer control using one of the Print or PrintDialog methods.

Please check the corresponded GdViewer.BeforePrintPageEventHandler for given parameters.

 
Public EventThis event is raised just before the global view of the viewer is going to rotate using the RotateView method or the displayed page is going to rotate using the Rotate method.

Please check the corresponded GdViewer.BeforeRotationEventHandler for given parameters.

 
Public EventThis event is raised before the zoom level is going to change.

Please check the corresponded GdViewer.BeforeZoomChangeEventHandler for more details.

 
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public EventThis event is raised when an item of the contextual menu has been clicked. The event occurs after the action specified by the clicked menu item has been executed.

Please check the corresponded GdViewer.ClickMenuEventHandler for given parameters.

 
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public EventThis event is raised right after the packet of the specified size has been successfully transferred during loading or saving a file using HTTP or FTP transfer.

Please check the corresponded GdViewer.DataReceivedEventHandler for given parameters.

 
Public Event (Inherited from System.Windows.Forms.Control)
Public EventThis event is raised when the currently displayed document has been successfully closed in the GdViewer control.

Please check the corresponded GdViewer.DocumentClosedEventHandler for more details.

 
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public EventThis event is raised when a file has been dropped in the current GdViewer control using the drag-and-drop feature. The event is explicitly raised when the AllowDropFile property is set to True/true.

Please check the corresponded GdViewer.DropFileEventHandler for given parameters.

 
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.UserControl)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public EventThis event is raised when a custom annotation is to be rendered. Your custom ModelID identifier, that you have defined when adding the custom annotation, should be used internally in this event to render the required annotation, as it is demontrated in the Example section below.

Please check the corresponded GdViewer.OnCustomAnnotationPaintEventHandler for given parameters.

The bounding box for the annotation appearance, that you need to follow, is defined by values x, y, w, h, where x and y define the coordinates of the top-left corner of the box as x = (Annot.Left - Annot.Width) / 2, y = (Annot.Top - Annot.Height) / 2, w defines the width of the box as w = Annot.Width and y defines the height of the box as y = Annot.Height.

The measurement unit used for specified dimensions and sizes is expressed in inches. The rotation, if any, is handled by the component, which automatically sets the required transformation.

 
Public Event (Inherited from System.Windows.Forms.Control)
Public EventThis event is raised after the current page has been successfully changed.

Please check the corresponded GdViewer.PageChangedEventHandler for more details.

 
Public EventThis event is raised after the current page has been successfully displayed.

Please check the corresponded GdViewer.PageDisplayedEventHandler for more details.

 
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public EventThis event is raised if a certificate (digital ID) is required to decrypt the loaded PDF document for display. The event is explicitly raised when the PdfShowOpenFileDialogForDecryption property is set to False/false.

Please check the corresponded GdViewer.PdfCertificateRequestEventHandler for given parameters.

You are allowed to prompt the user with your own dialog box for entering the certificate file for protected PDF documents using this event.

 
Public EventThis event is raised when a GoToR action contained in the displayed PDF document has been triggered to open a linked file. The event only occurs if the PdfEnableFileLinks property is set to True/true.

Please check the corresponded GdViewer.PdfFileNavigationEventHandler for given parameters.

 
Public EventThis event is raised when a Launch action contained in the displayed PDF document has been triggered to launch an application, usually to open or print a file.

Please check the corresponded GdViewer.PdfLaunchActionEventHandler for given parameters.

 
Public EventThis event is raised if a password is required to decrypt the loaded PDF document for display. The event is explicitly raised when the PdfShowDialogForPassword property is set to False/false.

Please check the corresponded GdViewer.PdfPasswordRequestEventHandler for given parameters.

You are allowed to prompt the user with your own dialog box for entering the password for protected PDF documents using this event.

 
Public EventThis event is raised when a URI action contained in the displayed PDF document has been triggered to resolve a uniform resource identifier. The event only occurs if the PdfEnableLinks property is set to True/true.

A URI is a string that identifies a resource on the Internet - typically a file that is the destination of a hypertext link, although it can also resolve to a query or other entity. URIs are described in RFC 2396 - Uniform Resource Identifier (URI).

Please check the corresponded GdViewer.PdfUriNavigationEventHandler for given parameters.

 
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public EventThis event is raised when the user has drawn or edited the rectangle of area selection using the mouse.

Please check the corresponded GdViewer.RectEditedByUserEventHandler for more details.

 
Public Event (Inherited from System.Windows.Forms.Control)
Public EventThis event is raised when a highlighted region has been moved or resized, which actually means edited, by a user using the mouse.

Please check the corresponded GdViewer.RegionEditedByUserEventHandler for given parameters.

Highlighted regions for currently displayed document are identified and created when searching text, for example using the SearchText(String,Int32,Boolean) method or the second similar overloaded method as well. You can also define highlighted regions directly using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods.

 
Public EventThis event is raised when a highlighted region has been moved by a user using the mouse.

Please check the corresponded GdViewer.RegionMovedByUserEventHandler for given parameters.

Highlighted regions for currently displayed document are identified and created when searching text, for example using the SearchText(String,Int32,Boolean) method or the second similar overloaded method as well. You can also define highlighted regions directly using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods.

 
Public EventThis event is raised when a highlighted region has been resized by a user using the mouse.

Please check the corresponded GdViewer.RegionResizedByUserEventHandler for given parameters.

Highlighted regions for currently displayed document are identified and created when searching text, for example using the SearchText(String,Int32,Boolean) method or the second similar overloaded method as well. You can also define highlighted regions directly using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods.

 
Public EventThis event is raised when a highlighted region has been selected by a user using the mouse.

Please check the corresponded GdViewer.RegionSelectedByUserEventHandler for given parameters.

Highlighted regions for currently displayed document are identified and created when searching text, for example using the SearchText(String,Int32,Boolean) method or the second similar overloaded method as well. You can also define highlighted regions directly using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Color) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Color) methods.

 
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public EventThis event is raised right after the global view of the viewer has been rotated using the RotateView method or the displayed page has been rotated using the Rotate method.

Please check the corresponded GdViewer.RotationEventHandler for given parameters.

 
Public EventThis event is raised right after the currently processed page has been successfully created and saved. It is only applied when the initial document is image-based.

Please check the corresponded GdViewer.SavingProgressEventHandler for given parameters.

The event is only raised when processing documents based on images using the SaveDocumentToPDF(String) or the SaveDocumentToTIFF(String,TiffCompression) methods and its overloads. The event is not raised, if your initial document is in PDF or TXT format and you are saving it using the SaveDocumentToPDF(String) method and its overloads. The event is not raised using the SaveDocumentToJPEG(String,Int32) method and its overloads as well.

 
Public Event (Inherited from System.Windows.Forms.ScrollableControl)
Public EventThis event is raised when the user scrolls through the GdViewer control area using the mouse move or when they scroll using the vertical or the horizontal scrollbars directly.

Please check the corresponded GdViewer.ScrollViewerEventHandler for more details.

 
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public EventThis event is raised right after the latest asynchronous web transfer has been finished when loading or saving a file using HTTP or FTP transfer.

Please check the corresponded GdViewer.TransferEndedEventHandler for given parameters.

 
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Public Event (Inherited from System.Windows.Forms.Control)
Top
See Also

Reference

GdViewer Class
GdPicture14 Namespace
GdViewer Constructor
Dispose Method