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 Method Adds a region on the current page of the displayed document.  
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.  Burns (or flatten) the GdPicture/XMP annotation of the current page of the displayed document. To burn custom annotations you need to use the overload taking a VectorMode parameter set to False.  
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 Method Moves the page of the displayed document to set the rectangle of selection at the middle of the viewer.  
Public Method Clears the viewer.  
Public Method Removes the rectangle of area selection from the viewer.  
Public Method Clear the text selection.  
Public MethodOverloaded.  (Inherited from System.Windows.DependencyObject)
Public Method Closes the displayed document.  
Public Method (Inherited from System.Windows.DependencyObject)
Public Method Makes a translation of a point coordinates from the document space, in inches, to the viewer space, in pixel.  
Public Method Makes a translation of a point coordinates from the document space, in pixel, to the viewer space, in pixel.  
Public Method Makes a translation of a point coordinates from the viewer space, in pixel, to the document space, in inch.  
Public Method Makes a translation of a point coordinates from the viewer space, in pixel, to the document space, in pixel.  
Public Method Copies a region of the displayed document into the Clipboard.  
Public Method Copies a region of the displayed document into a GdPicture Image.  
Public Method Copies the displayed document into the Clipboard.  
Public Method Removes a GdPicture/XMP annotation on the current page of the displayed document.  
Public Method Displays the first page of the current multipage document.  
Public Method Displays an image from a BitmapSource object.  
Public Method Displays a document from a file stored within an array of bytes.  
Public Method Displays an image stored into the clipboard.  
Public Method Displays a Device Independent Bitmap handle (DIB).  
Public Method Displays a document from a file.  
Public MethodOverloaded.  Displays a document from a file stored in a distant server using FTP access. The document will be loaded in an asynchronous way. You can catch the TransferProgress and the TransferEnded events to monitor the transfer.  
Public Method Displays a GdPicture Image.  
Public Method Displays a PDF document from a GdPicturePDF object.  
Public Method Displays an image from a handle to a Windows Microsoft Windows Graphics Device Interface (GDI).  
Public Method Displays an image from a handle to a Windows handle to icon.  
Public MethodOverloaded.  Displays a document from a file stored in a distant server using HTTP. The document will be loaded in an asynchronous way. You can catch the TransferProgress and the TransferEnded events to monitor the transfer.  
Public Method Avoids the downloading started by the DisplayFromHTTP() or DisplayFromFTP() method.  
Public Method Displays a document from a file stored within an area of the memory.  
Public Method Displays an Image from raw bitmap in memory.  
Public MethodOverloaded.  Displays document from a Stream object.  
Public Method Displays a document from a file stored within string data (Encoding 1252).  
Public Method Displays the last page of the current multipage document.  
Public Method Displays the next page of the current multipage document.  
Public Method Changes the displayed page of the current multipage document.  
Public Method Displays the previous page of the current multipage document.  
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 Method  
Public Method (Inherited from System.Windows.FrameworkElement)
Public Method Ensures that the specified region is visible within the control, scrolling the contents of the control if necessary.  
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 Method Returns the coordinates, in pixel, of the visible area of the displayed document.  
Public Method Returns the coordinates in inches of the visible area of the displayed document.  
Public Method Returns the type of the displayed document.  
Public Method (Inherited from System.Windows.DependencyObject)
Public Method Returns the maximum position of the horizontal scrollbar.  
Public Method Returns the current position of the horizontal scrollbar.  
Public Method Returns the path of the latest loaded file.  
Public Method Returns, if any, the last HTTP or FTP transfer error description.  
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 text of the current page of the displayed document.  
Public MethodOverloaded.  Returns the text in a specific rectangle in the current page of the displayed document.  
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 Method Retrieve the border color of a region.  
Public Method Retrieve the border width of a region.  
Public Method Retrieve the color of a region.  
Public Method Retrieve the color of a region, when it is selected by the user, from its ID.  
Public Method Retrieve the fill mode of a region.  
Public Method Retrieve the height, in inches, on the document, of a region.  
Public Method Retrieve the height, in pixels, on the document, of a region.  
Public Method Returns a region ID.  
Public Method Retrieve the left position in inches on the document, of a region.  
Public Method Retrieve the left position, in pixels, on the document, of a region.  
Public Method Retrieve the name of a region.  
Public Method Retrieve the page in a multipage document on which the region is drawn (set), by using the Region ID.  
Public Method Gets the selection status of a region, by using the Region ID.  
Public Method Retrieve the top position in inches on the document, of a region.  
Public Method Retrieve the top position, in pixels, on the document, of a region.  
Public Method Retrieve the width in inches on the document, of a region.  
Public Method Retrieve the width, in pixels, on the document, of a region.  
Public Method Returns the index of the selected GdPicture/XMP annotation.  
Public Method Returns the user selected text.  
Public Method Returns an array of rectangle which represent the regions bounding the selected text.  
Public Method Returns the last viewer Status.  
Public Method Searches a specific page of the displayed document for an occurrence of a given text string and returns the number of occurences found.  
Public Method (Inherited from System.Windows.DependencyObject)
Public Method Returns the GdPicture source code version used in the following format M.mrr where 'M' describes the major version, 'm' the medium version and 'rr' the release number.  
Public Method Returns the maximum position of the vertical scrollbar.  
Public Method Returns the current position of the vertical scrollbar.  
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 Method Returns the author of the displayed PDF.  
Public Method Returns the date of creation of the displayed PDF.  
Public Method Returns the creator of the displayed PDF.  
Public Method Returns if any, the mode of encryption of the displayed PDF.  
Public Method Returns the keywords of the displayed PDF.  
Public Method Returns if any, the Metadata of the displayed PDF.  
Public Method Returns the date of modification of the displayed PDF.  
Public Method Returns the producer of the displayed PDF.  
Public Method Returns the subject of the displayed PDF.  
Public Method Returns the title of the displayed PDF.  
Public Method Returns the version of the displayed PDF.  
Public Method (Inherited from System.Windows.Media.Visual)
Public Method (Inherited from System.Windows.Media.Visual)
Public Method (Inherited from System.Windows.FrameworkElement)
Public Method Prints the displayed document the active printer.  
Public MethodOverloaded.  Invokes the standard Windows Printer Dialog, which allows users to choose the printer settings, then prints the displayed document.  
Public Method Returns the selected printer name.  
Public Method Gets the image alignment into the page during a print process .  
Public Method Returns whether the printed document is collated.  
Public Method Returns the active printer color Mode.  
Public Method Returns the number of copies to print with the selected printer.  
Public Method Gets the document name 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 Method Gets the physical margins of the active printer.  
Public Method Returns the page orientation when printing.  
Public Method Returns the paperbin used by the active printer.  
Public Method Gets the paper height used by the active printer.  
Public Method Returns the current paper size of the active printer.  
Public Method Gets the paper width used by the active printer.  
Public Method Returns the name of an available printer.  
Public Method Returns the number of available printers.  
Public Method Returns the current quality of the active printer.  
Public MethodReturns the status of the last executed print operation.

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

 
Public Method Changes the active printer.  
Public Method Sets the image alignment into the page during a print process.  
Public Method Determines if the object rotate automatically pages to fit on the output medium.  
Public Method Sets document collate mode for the selected printer.  
Public Method Sets to the active printer the color mode for the print process.  
Public Method Tell to the active printer the number of copies to print.  
Public Method Sets the document name to display during the next print process (for example, in a print status dialog box or printer queue) while printing the document.  
Public Method Ask to the component for the next print process to print a range of page.  
Public Method Defines the page orientation when printing.  
Public Method Ask to the component for the next print process to print a selection of pages.  
Public Method Sets the paper bin used by the active printer.  
Public Method Specifies if pages must be pre-rasterized before being printed in order to improve performance with printer drivers non optimized for vector graphics rendering.  
Public Method Sets the quality of the active printer.  
Public Method Tells the component to show or hide progress indicator during printing (showed by default).  
Public Method Sets a standard paper size to use by the active printer.  
Public Method Sets a custom paper size to use by the active printer.  
Public Method Prompts the selected printer driver settings dialog.  
Public Method (Inherited from System.Windows.UIElement)
Public Method (Inherited from System.Windows.DependencyObject)
Public Method Redraws the displayed document.  
Public Method Returns the number of regions on the displayed document.  
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 Method Remove all regions from the current document.  
Public Method (Inherited from System.Windows.UIElement)
Public Method Removes an item of the contextual menu.  
Public Method Remove a region from a region identifier.  
Public Method Remove a region by using its name.  
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 Method Rotates clockwise or flips the current page of the displayed document.  
Public Method Rotates clockwise or flips the global view.  
Public Method Forces the viewer to save the annotations to the current page. This method is automatically called internally on 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 displayed document in JPEG format with GdPicture/XMP annotation support.  
Public MethodOverloaded.  Saves the displayed document in PDF format with GdPicture/XMP annotation support. In case of multipage document saving, the SavingProgress callback can be raised.  
Public MethodOverloaded.  Saves the displayed document in TIFF format with GdPicture/XMP annotation support. In case of multipage document saving, the SavingProgress callback can be raised.  
Public MethodOverloaded.  Searches the current page of the displayed document for a given text string.  
Public Method Selects all text of the current page.  
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 Method Specifies if the FTP transfer mode is Passive or not for the DisplayFromFTP() method. True by default.  
Public Method Moves to horizontal scrollbar to a specific position.  
Public Method Changes the default packet size used by the DisplayFromHTTP() and DisplayFromFTP methods. Default value used 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 Method Sets the border color of a region.  
Public Method Sets the border width of a region.  
Public Method Sets the color of a region.  
Public Method Sets the color of a region, when it is selected by the user, from a region identifier.  
Public Method Specifies if a region can be edited by user or not (can be by default).  
Public Method Retrieve the fill mode of a region.  
Public Method Sets the height, in inches, of a region.  
Public Method Sets the left position in inches, of a region.  
Public Method Sets the name of a region.  
Public Method Sets the page on which the region is to be drawn (set) by using the region's ID.  
Public Method Sets the selection status of a region, by using the Region ID.  
Public Method Sets the top position in inches, of a region.  
Public Method Sets the width in inches, of a region.  
Public Method (Inherited from System.Windows.FrameworkElement)
Public Method Moves both horizontal and vertical scrollbars to specific positions.  
Public MethodOverloaded.  (Inherited from System.Windows.DependencyObject)
Public Method Moves to vertical scrollbar to a specific position.  
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 Method Adjusts zoom and page position in order to display a specific area of the current displayed page.  
Public Method Increases the current level of zoom.  
Public Method Decreases the current level of zoom.  
Public Method Adjusts zoom to the area covered by the rectangle of selection.  
Top
See Also

Reference

GdViewer Class
GdPicture14.WPF Namespace