GdViewer Class Methods
GdPicture.NET Reference Guide
GdViewer Class Methods

GdPicture14.WPF Namespace : GdViewer Class

For a list of all members of this type, see GdViewer members.

Public Methods
 NameDescription
Public Method Allows the user to add a new connected lines annotation using the mouse.  
Public Method Allows the user to add a new ellipse annotation using the mouse.  
Public MethodOverloaded.  Allows the user to add a new embedded image annotation, from a GdPicture image, using the mouse.  
Public MethodOverloaded.  Allows the user to add a new free-hand annotation using the mouse.  
Public MethodOverloaded.  Allows the user to add a new free-hand highlighter annotation using the mouse.  
Public Method Allows the user to add a new free-hand polygon annotation using the mouse.  
Public MethodOverloaded.  (Inherited from System.Windows.UIElement)
Public Method Allows the user to add a new line annotation using the mouse.  
Public Method Allows the user to add a new line arrow annotation using the mouse.  
Public Method Allows the user to add a new link annotation using the mouse.  
Public Method Allows the user to add a new polygon annotation using the mouse.  
Public Method Allows the user to add a new poly ruler annotation using the mouse.  
Public Method Allows the user to add a new rectangle annotation using the mouse.  
Public Method Allows the user to add a new Highlighter rectangle annotation using the mouse.  
Public MethodAdds and highlights a new region on the current page of the document displayed in the GdViewer control according to what you have specified. This method uses inches to define the position and the size of the region's rectangle.

The region is highlighted immediately using the specified color. At the same, it is added to the list of all highlighted regions related to the displayed document. You can find out the number of currently defined highlighted regions using the RegionCount method.

Please note, that highlighted regions are also determined using both SearchText(String,Int32,Boolean) and SearchText(String,Int32,Boolean,Boolean) methods.

 
Public Method Allows the user to add a new rubber stamp annotation using the mouse.  
Public Method Allows the user to add a new ruler annotation using the mouse.  
Public Method Allows the user to add a new sticky note annotation using the mouse.  
Public Method Allows the user to add a new text annotation using the mouse.  
Public Method (Inherited from System.Windows.UIElement)
Public MethodOverloaded.  (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.FrameworkElement)
Public Method (Inherited from System.Windows.UIElement)
Public MethodOverloaded.  (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.FrameworkElement)
Public MethodOverloaded.  (Inherited from System.Windows.FrameworkElement)
Public MethodOverloaded.  (Inherited from System.Windows.FrameworkElement)
Public MethodOverloaded. Burn, in other words flatten, the GdPicture/XMP annotations into the current page of the displayed document in the viewer.  
Public Method Asks to the control to ignore the latest request of interactive annotation creation.  
Public Method (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.UIElement)
Public MethodMoves the currently displayed page in the viewer control so that the rectangle of selection is in the middle of the viewer. You can use the IsRect method to determine if any selection rectangle is defined.  
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 Method Removes the rectangle of area selection from the viewer.  
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.  (Inherited from System.Windows.DependencyObject)
Public MethodCloses the currently displayed document and clears the GdViewer control.

The DocumentClosed event is raised at the end after the document has been successfully closed.

 
Public Method (Inherited from System.Windows.DependencyObject)
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 GdPicture image 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 GdPicture image 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 Removes a GdPicture/XMP annotation on the current page of the displayed document.  
Public MethodDisplays the first page of the document currently loaded in the viewer. You can use the CurrentPage property to determine the currently displayed page.

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

 
Public MethodLoads an image data stored in a System.Windows.Media.Imaging.BitmapSource 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 viewer. 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 viewer. 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 viewer. 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 viewer. Both events are only raised if the image has been successfully loaded.

 
Public MethodLoads a document from a file according to a file path you have specified 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 viewer. Both events are only raised if the document has been successfully loaded.

 
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 identifier of the GdPicture image 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 viewer. 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 viewer. 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 viewer. 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 viewer. 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 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 viewer. 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 viewer. 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 viewer. Both events are only raised if the document has been successfully loaded.

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

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 viewer. You can use the CurrentPage property to determine the currently displayed page.

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 viewer. The value of the CurrentPage property is changed to the specified page number as well.

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 viewer. You can use the CurrentPage property to determine the currently displayed page.

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

 
Public Method Prompts the annotation text modification dialog box to the user. Can be used with StickyNote and Text annotations only. This method is particularly useful if you want to let the user subsequently define the text of the annotation after having added it (see example).  
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.FrameworkElement)
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.DependencyObject)
Public Method (Inherited from System.Windows.Media.Visual)
Public Method (Inherited from System.Windows.FrameworkElement)
Public Method (Inherited from System.Windows.FrameworkElement)
Public Method (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.UIElement)
Public Method Returns the number of GdPicture/XMP annotations available on the current page of the displayed document.  
Public Method Returns a GdPicture/XMP annotations available on the current page of the displayed document.  
Public Method Gets the AnnotationManager object associated with the Viewer.  
Public Method (Inherited from System.Windows.FrameworkElement)
Public MethodReturns coordinates and dimensions, in pixels, of the document's visible area within the viewer. 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 viewer. 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 type of the document currently displayed in the GdViewer control.  
Public Method (Inherited from System.Windows.DependencyObject)
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.  
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.Windows.DependencyObject)
Public Method Returns the bounds, in pixels, of the viewer area used to render the current page.  
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 Method Creates a High Quality thumbnail (returns a GdPicture image) of custom size from a page of the displayed document. This method fits the image thumbnail within a rectangle of specified dimensions having a specified background color. This GdPicture image can be used by another GdPictureImaging or GdViewer object.  
Public Method Returns the coordinates, in inches, of the rectangle of area selection over the document.  
Public Method Returns the coordinates, in pixel, of the rectangle of area selection over the document.  
Public Method Returns the coordinates, in pixel, of the rectangle of area selection over the viewer.  
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 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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method or directly using the SetRegionColor 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 method.

 
Public MethodGets the fill 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 fill 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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method or directly using the SetRegionFillMode 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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method 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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method or directly using the SetRegionHeight 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's rectangle when adding regions using the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method 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's rectangle when adding regions using the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method or directly using the SetRegionLeft 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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method 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.

 
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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method 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's rectangle when adding regions using the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method or directly using the SetRegionTop 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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method 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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method or directly using the SetRegionWidth method.

 
Public Method Returns the index of the selected GdPicture/XMP annotation.  
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 MethodSearches for an occurrence of a given text expression within the specified page of the displayed document according to the parameters you have specified. If the format of the displayed document is other than supported text-based formats, which currently are DOCX, TXT, RTF and PDF, this method will fail.  
Public Method (Inherited from System.Windows.DependencyObject)
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 Method Plays a GIF animation in loop.  
Public Method Stops a GIF animation.  
Public Method Hides the text modification dialog box from the control. Can be used with StickyNote and Text annotations only. If the annotation text modification dialog is not displayed, this method returns a GdPictureStatus.Aborted status.  
Public Method (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.DependencyObject)
Public Method (Inherited from System.Windows.UIElement)
Public Method Returns the number of IPTC Tags attached to the displayed document.  
Public Method Returns an IPTC Tag ID attached to the displayed document.  
Public Method Returns as string, the value of an IPTC Tag attached to the displayed document.  
Public Method (Inherited from System.Windows.Media.Visual)
Public Method Indicates whether the specified point, in the control space, is contained within a specific annotation bounding box.  
Public Method (Inherited from System.Windows.Media.Visual)
Public Method Returns True if the rectangle of area selection is drawn on the viewer, else false.  
Public Method Returns if the user is drawing the rectangle of area selection.  
Public Method Returns if the user is moving the rectangle of area selection.  
Public Method Returns if the user is resizing the rectangle of area selection.  
Public MethodOverloaded.  Loads and applies GdPicture/XMP annotation from a XML file previously generated by the SaveAnnotationsToXMP or SaveAnnotationsToXMPEx methods.  
Public Method (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.FrameworkElement)
Public Method (Inherited from System.Windows.FrameworkElement)
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 viewer 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 viewer 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 viewer 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 viewer 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 viewer 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 viewer 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 viewer 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 viewer 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 viewer 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 viewer 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 viewer is not the PDF file, the method will fail.  
Public Method (Inherited from System.Windows.Media.Visual)
Public Method (Inherited from System.Windows.Media.Visual)
Public Method (Inherited from System.Windows.FrameworkElement)
Public MethodPrints the document currently displayed in the GdViewer control to the active printer allowing you to adjust the size of printed pages.

The BeforePrintPage and the AfterPrintPage events are raised just before and right after the single page is printed.

 
Public MethodOverloaded. Invokes the standard Windows Print dialog box allowing you to print the displayed document by choosing additional settings.  
Public MethodReturns the name of the printer, that is currently selected as the active printer, i.e. 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, i.e. 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 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, i.e. 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, i.e. 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 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 GdPicturePDF object.

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, i.e. 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, i.e. 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 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(PrintSizeOption) method.

 
Public MethodSets up the paper source, i.e. the paper tray, from which the printer gets paper, used by the active printer. The value matches up to the PaperSource.Kind property of the default paper settings.  
Public MethodEnables or disables the pre-rasterization parameter, that specifies, if the pages of the currently displayed document 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 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, i.e. 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 MethodPrompts the printer driver to show the printer settings dialog box of the active printer.  
Public Method (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.DependencyObject)
Public MethodRedraws the displayed document within the GdViewer control, that means refresh the displayed area of the viewer to show the currently loaded document, if any is defined.  
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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method. Be aware that highlighted regions are also determined using both SearchText(String,Int32,Boolean) and SearchText(String,Int32,Boolean,Boolean) methods.

 
Public Method (Inherited from System.Windows.FrameworkElement)
Public Method (Inherited from System.Windows.UIElement)
Public Method Deletes a GdPicture Image from the memory.  
Public Method (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.UIElement)
Public Method Forces the viewer to reload the annotations of the current page. Use this method only if the displayed image has been edited by another object. A call to the Redraw method is needed to refresh the screen.  
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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method. Be aware that highlighted regions are also determined using both SearchText(String,Int32,Boolean) and SearchText(String,Int32,Boolean,Boolean) methods.

 
Public Method (Inherited from System.Windows.UIElement)
Public Method Removes an item of the contextual menu.  
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 Rotates all annotations (use the page coordinate system) by a specific angle. A call to the Redraw method is needed to refresh the screen.  
Public MethodRotates clockwise or flips the current page of the displayed document 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.  
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.  
Public MethodForces the GdViewer control to save annotations to the current page, that is defined by the CurrentPage property.

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 displayed document to a XML file.  
Public MethodOverloaded.  Saves the GdPicture/XMP annotation part of all pages of the displayed document to a XML file.  
Public MethodOverloaded. Saves the document displayed in the viewer to a file in JPEG format with full GdPicture XMP annotation suppport.  
Public MethodOverloaded. Saves the document displayed in the viewer to a file in PDF format with full GdPicture XMP annotation suppport.  
Public MethodOverloaded. Saves the document displayed in the viewer to a file in TIFF format with full GdPicture XMP annotation suppport.  
Public MethodOverloaded. Searches for an occurrence of a given text expression within the defined page of the displayed document according to the specified parameters and highlights the result or returns its coordinates.  
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 Method Selects a GdPicture/XMP annotation.  
Public Method Defines the "editor mode" for the GdPicture/XMP annotation support.  
Public MethodOverloaded.  (Inherited from System.Windows.FrameworkElement)
Public Method (Inherited from System.Windows.DependencyObject)
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.  
Public MethodChanges the packet size used for transfering data by the DisplayFromHTTP(String,String,Int32) and DisplayFromFTP(String,String,String) methods. The initial value is 4096.  
Public Method Changes the caption of an item of the contextual menu.  
Public Method Sets the coordinates in inches of the rectangle of area selection over the page of the displayed document.  
Public Method Sets the coordinates, in pixel, of the rectangle of area selection over the page of the displayed document.  
Public Method Sets the coordinates, in pixel, of the rectangle of area selection over the viewer.  
Public MethodSets 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 determine the border color of each highlighted region using the GetRegionBorderColor method.

 
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 the region's rectangle using the GetRegionBorderWidth method.

 
Public MethodSets 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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method. You can determine the fill color of each highlighted region using the GetRegionColor method.

Please note, that you need to redraw the control using the Redraw method to immediately apply the newly defined color.

 
Public MethodSets 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 determine this fill color of each highlighted region using the GetRegionColorSelection method.

 
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. They are editable by default.  
Public MethodSets the fill 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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method. You can determine this parameter of each highlighted region using the GetRegionFillMode method.

 
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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method. You can determine the height of the region's rectangle using the GetRegionHeight 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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method. You can determine this coordinate of the region's rectangle using the GetRegionLeft 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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method. 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.

 
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's rectangle when adding regions using the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method. You can determine this coordinate of the region's rectangle using the GetRegionTop method.

 
Public MethodSets 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 the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method. You can determine the width of the region's rectangle using the GetRegionWidth method.

 
Public Method (Inherited from System.Windows.FrameworkElement)
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 MethodOverloaded.  (Inherited from System.Windows.DependencyObject)
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.  
Public Method Returns the number of Tags (Exif, Extra, Thumbnails & GPS) attached to the displayed document.  
Public Method Returns an Exif Tag ID attached to the displayed document.  
Public Method Returns as string a Tag name attached to the displayed document.  
Public Method Returns as string, the value of a Tag attached to the displayed document.  
Public Method (Inherited from System.Windows.Controls.Control)
Public MethodOverloaded.  (Inherited from System.Windows.Media.Visual)
Public Method (Inherited from System.Windows.Media.Visual)
Public Method (Inherited from System.Windows.Media.Visual)
Public Method (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.FrameworkElement)
Public Method (Inherited from System.Windows.FrameworkElement)
Public Method (Inherited from System.Windows.FrameworkElement)
Public Method (Inherited from System.Windows.UIElement)
Public MethodAdjusts the current zoom to the area covered by the specified rectangle on the current page of the document displayed in the viewer. The viewer control is subsequently refreshed to zoom on the defined area.  
Public MethodIncreases the current zoom level, it means zooms in on the viewer. 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 viewer as well.

 
Public MethodDecreases the current zoom level, it means zooms out on the viewer. 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 viewer as well.

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

The viewer control is subsequently refreshed to zoom on the defined rectangle.

 
Top
See Also

Reference

GdViewer Class
GdPicture14.WPF Namespace
GdViewer Constructor
Dispose Method