| Name | Description | |
|---|---|---|
 | AddConnectedLinesAnnotInteractive | Allows users to interactively add a new connected lines annotation using the mouse on the current page of the document displayed in the GdViewer control. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
A connected lines annotation depicts a polyline consisting of several straight lines. This method uses the round cap style on both polyline ending points. Users end every individual line with a single click, and they finish the annotation with a double-click. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeConnectedLines. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationConnectedLines class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddEllipseAnnotInteractive | Allows users to interactively add a new ellipse annotation using the mouse on the current page of the document displayed in the GdViewer control. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
This annotation enables users to draw a filled and bordered ellipse or circle by adjusting its height and width continuously using the mouse. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeEllipse. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationEllipse class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddEmbeddedImageAnnotInteractive | Overloaded. 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. |
| AddFreeHandAnnotInteractive | Overloaded. Allows users to interactively add a new freehand annotation using the mouse on the current page of the document displayed in the GdViewer control. |
| AddFreeHandHighlighterAnnotInteractive | Overloaded. 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. |
| AddFreeHandPolygonAnnotInteractive | 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. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
A freehand polygon is an arbitrary closed shape which users paint by moving the mouse. Drawing a polygon starts with pressing the mouse button and it finishes with releasing the mouse button. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeFreeHandPolygon. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationFreeHandPolygon class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddHandler | Overloaded. (Inherited from System.Windows.UIElement) |
| AddLineAnnotInteractive | Allows users to interactively add a new line annotation using the mouse on the current page of the document displayed in the GdViewer control. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
A line annotation presents a single straight line with specified cap styles on its ending points. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeLine. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationLine class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddLineArrowAnnotInteractive | 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. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
This annotation depicts a straight line with an arrow on one of its ending points. Using this method you can specify if the arrowhead is painted when users start the line or when they finish it. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeLineArrow. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationLineArrow class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddLinkAnnotationInteractive | Allows users to interactively add a new link annotation using the mouse on the current page of the document displayed in the GdViewer control. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
A link annotation depicts the defined text, that points to a link destination, that means to a web site or to a page in the current document. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeLink. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationLink class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddPolygonAnnotInteractive | Allows users to interactively add a new polygon annotation using the mouse on the current page of the document displayed in the GdViewer control. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
Users start drawing a polygon with a single line. Each single click adds a new polygon vertice. To finish the polygon they use a double-click. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypePolygon. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationPolygon class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddPolyRulerAnnotInteractive | 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. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
A poly ruler annotation consists of several connected lines presenting its entire length. Users end every individual line with a single click, and they finish the annotation with a double-click. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypePolyRuler. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationPolyRuler class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddRectangleAnnotInteractive | Allows users to interactively add a new rectangle annotation using the mouse on the current page of the document displayed in the GdViewer control. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
This annotation enables users to draw a filled and bordered rectangle or square by adjusting its height and width continuously using the mouse. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeRectangle. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationRectangle class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddRectangleHighlighterAnnotInteractive | 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. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
This annotation enables users to highlight a required area by adjusting the height and the width of the rectangle highlighter continuously using the mouse. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeRectangleHighlighter. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationRectangleHighlighter class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddRedactionAnnotInteractive | Allows users to interactively add a new redaction annotation using the mouse on the current page of the document displayed in the GdViewer control. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
This annotation enables users to mark regions for redaction by adjusting the height and the width of the annotation continuously using the mouse. The redaction annotations are used as input for the ApplyAllRedactions method. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeRedaction. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationRedaction 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. |
| AddRegion | Adds 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. You can also benefit from using both events related to highlighted regions, the RegionEdited event and the RegionSelected event, respectively the PreviewRegionEdited event and the PreviewRegionSelected event. |
| AddRubberStampAnnotInteractive | 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. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
This annotation shows a stamp mark of the specified stamp within the area defined by the user. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeRubberStamp. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationRubberStamp class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddRulerAnnotInteractive | Allows users to interactively add a new ruler annotation using the mouse on the current page of the document displayed in the GdViewer control. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
A ruler annotation depicts a single drawn line showing its length. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeRuler. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationRuler class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddStickyNoteAnnotationInteractive | 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. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
A sticky note annotation writes the specified text within the area defined by the user. You can prompt users to add their custom text using the DisplayTextEditBox method right after creating the annotation object. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeStickyNote. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationStickyNote class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddTextAnnotationInteractive | Allows users to interactively add a new text annotation using the mouse on the current page of the document displayed in the GdViewer control. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.
A text annotation writes the specified text within the rectangle area defined by the user. You can prompt users to add their custom text using the DisplayTextEditBox method right after creating the annotation object. The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeText. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationText class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events, respectively to both the PreviewBeforeAnnotationAddedByUser and the PreviewAnnotationAddedByUser 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. |
| AddToEventRoute | (Inherited from System.Windows.UIElement) |
| ApplyAllRedactions | Applies all redactions to the native document based on redaction annotations present in the document. |
| ApplyAnimationClock | Overloaded. (Inherited from System.Windows.UIElement) |
| ApplyTemplate | (Inherited from System.Windows.FrameworkElement) |
| Arrange | (Inherited from System.Windows.UIElement) |
| BeginAnimation | Overloaded. (Inherited from System.Windows.UIElement) |
| BeginInit | (Inherited from System.Windows.FrameworkElement) |
| BeginStoryboard | Overloaded. (Inherited from System.Windows.FrameworkElement) |
| BringIntoView | Overloaded. (Inherited from System.Windows.FrameworkElement) |
| BurnAnnotationsToPage | Overloaded. Burn, in other words flatten, the GdPicture/XMP annotations into the current page of the document displayed in the GdViewer control. |
| CancelLastAnnotInteractiveAdd | Asks the GdViewer control to ignore the latest request of an interactive annotation creation.
This method only works when the editing mode for annotations is enabled; otherwise, the method will fail. |
| CaptureMouse | (Inherited from System.Windows.UIElement) |
| CaptureStylus | (Inherited from System.Windows.UIElement) |
| CaptureTouch | (Inherited from System.Windows.UIElement) |
| CenterOnRect | Moves the current page of the document displayed in the GdViewer control within the viewer to set the rectangle of area selection, if any is defined, in the middle of the viewer. You can use the IsRect method to find out, if the rectangle of selection is currently specified. |
| Clear | Clears 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. |
| ClearRect | Removes 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 viewer. 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. |
| ClearSelectedText | Clears 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. |
| ClearValue | Overloaded. (Inherited from System.Windows.DependencyObject) |
| CloseDocument | Closes the currently displayed document and clears the GdViewer control.
The DocumentClosed event is raised at the end after the document has been successfully closed. |
| CoerceValue | (Inherited from System.Windows.DependencyObject) |
| CoordDocumentInchToViewerPixel | Translates 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. |
| CoordDocumentPixelToViewerPixel | Translates 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. |
| CoordViewerPixelToDocumentInch | Translates 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. |
| CoordViewerPixelToDocumentPixel | Translates 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. |
| CopyRegionToClipboard | Copies 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. |
| CopyRegionToGdPictureImage | Copies 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. |
| CopyToClipboard | Copies 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. |
| DeleteAnnotation | Removes 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. |
| DisplayFirstPage | Displays 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, respectively the PreviewPageDisplayed and the PreviewPageChanged 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. |
| DisplayFromBitmapSource | Loads 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 GdViewer control. Both events are only raised if the image has been successfully loaded. |
| DisplayFromByteArray | Loads 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. |
| DisplayFromClipboard | Loads 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. |
| DisplayFromDIB | Loads 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. |
| DisplayFromFile | Loads 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 GdViewer control. Both events are only raised if the document has been successfully loaded. |
| DisplayFromFTP | Overloaded. Loads a document from a file stored on a distant server using FTP transfer and subsequently displays it in the GdViewer control. |
| DisplayFromGdPictureImage | Loads 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. |
| DisplayFromGdPicturePDF | Loads 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. |
| DisplayFromHBitmap | Loads 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. |
| DisplayFromHICON | Loads 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. |
| DisplayFromHTTP | Overloaded. Loads a document from a file stored on a distant server using HTTP transfer and subsequently displays it in the GdViewer control. |
| DisplayFromHTTPStop | Cancels the download process previously started using the DisplayFromFTP(String,String,String) or the DisplayFromFTP(String,String,String) methods. |
| DisplayFromMemory | Loads 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. |
| DisplayFromRawBits | Loads 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. |
| DisplayFromStream | Overloaded. Loads documents or images from a Stream object and subsequently displays it in the GdViewer control. |
| DisplayFromString | Loads 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. |
| DisplayLastPage | Displays 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, respectively the PreviewPageDisplayed and the PreviewPageChanged 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. |
| DisplayNextPage | Displays 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, respectively the PreviewPageDisplayed and the PreviewPageChanged 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. |
| DisplayPage | Changes 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, respectively the PreviewPageDisplayed and the PreviewPageChanged 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. |
| DisplayPreviousPage | Displays 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, respectively the PreviewPageDisplayed and the PreviewPageChanged 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. |
| DisplayTextEditBox | Allows users to modify the annotation text directly within the defined annotation's rectangle area. 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's rectangle area will serve as editable dialogue box. Please refer to the attached example how it works. The AnnotationStartEditingText event, respectively the PreviewAnnotationStartEditingText event is raised after opening the dialogue box. |
| Dispose | Disposes already used GdViewer object completely. All related resources used by this object are released.
This method implicitly calls the CloseDocument method. |
| EndInit | (Inherited from System.Windows.FrameworkElement) |
| EnsureRegionVisibility | Ensures 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. |
| Equals | (Inherited from System.Windows.DependencyObject) |
| FindCommonVisualAncestor | (Inherited from System.Windows.Media.Visual) |
| FindName | (Inherited from System.Windows.FrameworkElement) |
| FindResource | (Inherited from System.Windows.FrameworkElement) |
| Focus | (Inherited from System.Windows.UIElement) |
| GetAnimationBaseValue | (Inherited from System.Windows.UIElement) |
| GetAnnotationCount | Returns 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. |
| GetAnnotationFromIdx | Returns 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. |
| GetAnnotationManager | Gets 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. |
| GetBindingExpression | (Inherited from System.Windows.FrameworkElement) |
| GetDisplayedArea | Returns 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. |
| GetDisplayedAreaInch | Returns 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. |
| GetDocumentType | Returns the type of the document currently displayed in the GdViewer control. |
| GetHashCode | (Inherited from System.Windows.DependencyObject) |
| GetHorizontalScrollBarMaxPosition | Gets 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. |
| GetHorizontalScrollBarPosition | Gets 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. |
| GetLastPath | Returns 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 the AddEmbeddedImageAnnotInteractive(String,Boolean,Color,Single,Single) method overwrites the last used path with its ImagePath parameter. |
| GetLastTransferError | Returns 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. |
| GetLocalValueEnumerator | (Inherited from System.Windows.DependencyObject) |
| GetPageBounds | Returns coordinates and dimensions, in pixels, of the viewer area, which is covered by the current page of the document displayed in the GdViewer control. Be aware that the resulting coordinate may be negative if the currently displayed page is shifted outside the viewer area. |
| GetPageText | Overloaded. Returns the whole text of the specified page of the document displayed in the GdViewer control. |
| GetPageTextArea | Overloaded. Returns the text, that is contained within a specific area of the page of the text-based document displayed in the GdViewer control. |
| GetPageThumbnail | Creates a custom sized high quality (HQ) thumbnail of the specified page of the document displayed in the GdViewer control. The required page is converted to an image resource with the size and the background color you have specified, which is subsequently stored as an object of the type GdPictureImage. The created image is clearly recognizable by the returned unique image identifier and you can take advantages of the GdPicture14.GdPictureImaging or the GdViewer classes and their methods for further manipulation with the thumbnail. |
| GetRectCoordinatesOnDocumentInch | Gets 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. |
| GetRectCoordinatesOnDocumentPixel | Gets 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. |
| GetRectCoordinatesOnViewerPixel | Gets 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. |
| GetRegionBorderColor | Gets 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. |
| GetRegionBorderWidth | Gets 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. |
| GetRegionColor | Gets 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. |
| GetRegionColorSelection | Gets 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. |
| GetRegionFillMode | Gets 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. |
| GetRegionHeight | Gets 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. |
| GetRegionHeightPixels | Gets 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. |
| GetRegionID | Returns 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. |
| GetRegionLeft | Gets 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. |
| GetRegionLeftPixels | Gets 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. |
| GetRegionName | Gets 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. |
| GetRegionPage | Gets 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. |
| GetRegionSelected | Gets 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. You can change the selection of each highlighted region using the SetRegionSelected method. You can also benefit from using the RegionSelected event, respectively the PreviewRegionSelected event. |
| GetRegionTop | Gets 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. |
| GetRegionTopPixels | Gets 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. |
| GetRegionWidth | Gets 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. |
| GetRegionWidthPixels | Gets 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. |
| GetSelectedAnnotationIdx | Returns 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. |
| GetSelectedText | Returns the last text selected by the user. This text is stored until you call the ClearSelectedText method to release it. |
| GetSelectedTextRegions | Returns 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. |
| GetStat | Returns the status of the last executed operation with this GdViewer control. |
| GetTextOccurrenceCount | Overloaded. 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. |
| GetValue | (Inherited from System.Windows.DependencyObject) |
| GetVerticalScrollBarMaxPosition | Gets 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. |
| GetVerticalScrollBarPosition | Gets 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. |
| GifPlay | Plays a GIF animation referring to the file displayed in the GdViewer control in a loop. |
| GifStop | Stops the currently played GIF animation referring to the file displayed in the GdViewer control. |
| HideTextEditBox | Terminates 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's 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, respectively the PreviewAnnotationEndEditingText event is raised after closing the dialogue box. |
| InputHitTest | (Inherited from System.Windows.UIElement) |
| InvalidateArrange | (Inherited from System.Windows.UIElement) |
| InvalidateMeasure | (Inherited from System.Windows.UIElement) |
| InvalidateProperty | (Inherited from System.Windows.DependencyObject) |
| InvalidateVisual | (Inherited from System.Windows.UIElement) |
| IPTCCount | Returns 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. |
| IPTCGetID | Returns 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. |
| IPTCGetValueString | Returns a string representation of the current tag value of the required IPTC tag, that is embedded within the document displayed in the GdViewer control. |
| IsAncestorOf | (Inherited from System.Windows.Media.Visual) |
| IsAnnotationVisibleAt | Indicates, 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. |
| IsDescendantOf | (Inherited from System.Windows.Media.Visual) |
| IsRect | Detects, 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.
You can define the custom rectangle of selection using one of these methods: SetRectCoordinatesOnDocumentPixel , SetRectCoordinatesOnDocumentInch and SetRectCoordinatesOnViewerPixel. 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. |
| IsRectDrawing | Detects, 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 RectEdited event, respectively the PreviewRectEdited event, is raised when the rectangle has been successfully drawn. |
| IsRectMoving | Detects, if the user is moving 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 RectEdited event, respectively the PreviewRectEdited event, is raised when the rectangle has been successfully moved. |
| IsRectResizing | Detects, if the user is resizing 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 RectEdited event, respectively the PreviewRectEdited event, is raised when the rectangle has been successfully resized. |
| LoadAnnotationsFromXMP | Overloaded. 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. |
| Measure | (Inherited from System.Windows.UIElement) |
| MoveFocus | (Inherited from System.Windows.FrameworkElement) |
| OnApplyTemplate | (Inherited from System.Windows.FrameworkElement) |
| PdfGetAuthor | Returns 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. |
| PdfGetCreationDate | Returns 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. |
| PdfGetCreator | Returns 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. |
| PdfGetEncryptionScheme | Returns 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. |
| PdfGetKeywords | Returns 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. |
| PdfGetMetadata | Returns 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. |
| PdfGetModificationDate | Returns 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. |
| PdfGetProducer | Returns 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. |
| PdfGetSubject | Returns 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. |
| PdfGetTitle | Returns 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. |
| PdfGetVersion | Returns 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. |
| PointFromScreen | (Inherited from System.Windows.Media.Visual) |
| PointToScreen | (Inherited from System.Windows.Media.Visual) |
| PredictFocus | (Inherited from System.Windows.FrameworkElement) |
| Prints 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. | |
| PrintDialog | Overloaded. Invokes the standard Windows Print dialog box allowing you to print the displayed document by selecting additional settings. |
| PrintGetActivePrinter | Returns 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. |
| PrintGetAlignment | Returns the value of an image alignment setting of the active printer. This value determines how the image is aligned when printing. |
| PrintGetCollate | Returns the printer collate setting of the active printer. This property determines, whether the printed document is collated.
true will print a complete copy of the document before the first page of the next copy is printed. false will print each page by the number of copies specified before printing the next page. |
| PrintGetColorMode | Returns the printer color mode setting of the active printer. This property determines whether the output will print in color or in monochrome. |
| PrintGetCopies | Returns the printer copies setting of the active printer, that means the number of copies to be printed. |
| PrintGetDocumentName | Returns 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. |
| PrintGetLastError | Returns the error description of the last executed print operation, that has failed specifically with the GdPictureStatus.PrintingException error. |
| PrintGetMargins | Returns 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. |
| PrintGetOrientation | Returns the printer orientation setting of the active printer. This property determines the page orientation when printing. |
| PrintGetPaperBin | Returns 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. |
| PrintGetPaperHeight | Returns the height of the paper to be used by the active printer. |
| PrintGetPaperSize | Returns 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. |
| PrintGetPaperWidth | Returns the width of the paper to be used by the active printer. |
| PrintGetPrinterName | Returns 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. |
| PrintGetPrintersCount | Returns the number of all available (installed) printers on the computer. |
| PrintGetQuality | Returns the printer quality setting of the active printer. This setting matches the PrinterResolutionKind property included in the PrinterSettings.PrinterResolutions parameter of the active printer. |
| PrintGetStat | Returns 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. |
| PrintSetActivePrinter | Sets 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. |
| PrintSetAlignment | Sets up the value of an image alignment setting of the active printer. This value determines how the image is aligned when printing. |
| PrintSetAutoRotation | Sets 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. |
| PrintSetCollate | Sets up the printer collate setting of the active printer. This property determines, whether the printed document is collated.
Setting it to true will print a complete copy of the document before the first page of the next copy is printed. Setting it to false will print each page by the number of copies specified before printing the next page. |
| PrintSetColorMode | Sets up the printer color mode setting of the active printer. This property determines whether the output will print in color or in monochrome. |
| PrintSetCopies | Sets up the printer copies setting of the active printer, that means the number of copies to be printed. |
| PrintSetDocumentName | Sets 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. |
| PrintSetFromToPage | Sets up the required range of pages you want to print during the next print process using the active printer. |
| PrintSetOrientation | Sets up the printer orientation setting of the active printer. This property determines the page orientation when printing. |
| PrintSetPageSelection | Sets 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. |
| PrintSetPaperBin | Sets up the paper source, means 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. |
| PrintSetPreRasterization | Enables 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.
You can also define the rendering resolution using the PrintSetPreRasterizationDPI method when pre-rasterization is enabled. |
| PrintSetPreRasterizationDPI | Specifies the rendering resolution to be used when pre-rasterization is enabled using the PrintSetPreRasterization method. |
| PrintSetQuality | Sets 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. |
| PrintSetShowPrintingProgress | Enables or disables showing the progress indicator during the print process. The printing progress bar is displayed by default. |
| PrintSetStdPaperSize | Sets up the standard paper size, means the type of the paper, to be used by the active printer. |
| PrintSetUserPaperSize | Sets up a custom paper size to be used by the active printer. |
| PrintShowPrinterSettingsDialog | Prompts the printer driver to show the printer settings dialog box of the active printer. |
| RaiseEvent | (Inherited from System.Windows.UIElement) |
| ReadLocalValue | (Inherited from System.Windows.DependencyObject) |
| Redraw | Redraws 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. |
| RegionCount | Returns 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. |
| RegisterName | (Inherited from System.Windows.FrameworkElement) |
| ReleaseAllTouchCaptures | (Inherited from System.Windows.UIElement) |
| ReleaseGdPictureImage | Releases a specified image and its corresponding image resource from memory. |
| ReleaseMouseCapture | (Inherited from System.Windows.UIElement) |
| ReleaseStylusCapture | (Inherited from System.Windows.UIElement) |
| ReleaseTouchCapture | (Inherited from System.Windows.UIElement) |
| ReloadAnnotations | Forces 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. |
| RemoveAllRegions | Removes 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. |
| RemoveHandler | (Inherited from System.Windows.UIElement) |
| RemoveItemMenu | Removes 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. |
| RemoveRegionByID | Removes 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. |
| RemoveRegionByName | Removes 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. |
| RotateAnnotations | Rotates 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. |
| RotatePage | Rotates 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 BeforePageRotation event is raised just before the rotation process starts and the AfterPageRotation event is raised right after the rotation process finishes. |
| RotateView | Rotates 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. |
| SaveAnnotationsToPage | Forces 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. This method is applied internally automatically on each page change. |
| SaveAnnotationsToXMP | Overloaded. 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. |
| SaveAnnotationsToXMPEx | Overloaded. 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. |
| SaveDocumentToJPEG | Overloaded. Saves the document displayed in the viewer to a file in JPEG format with full GdPicture XMP annotation suppport. |
| SaveDocumentToPDF | Overloaded. Saves the document displayed in the viewer to a file in PDF format with full GdPicture XMP annotation suppport. |
| SaveDocumentToTIFF | Overloaded. Saves the document displayed in the viewer to a file in TIFF format with full GdPicture XMP annotation suppport. |
| SearchText | Overloaded. 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. |
| SearchTextRegex | Overloaded. 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. |
| SelectAllText | Selects 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. |
| SelectAnnotation | Selects 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. |
| SetAnnotationEditorMode | Turns 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. |
| SetBinding | Overloaded. (Inherited from System.Windows.FrameworkElement) |
| SetCurrentValue | (Inherited from System.Windows.DependencyObject) |
| SetFtpPassiveMode | Specifies whether the FTP transfer mode used by DisplayFromFTP(String,String,String) method is Passive or not. The initial value is true. |
| SetHorizontalScrollBarPosition | Sets 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 Scroll event, respectively the PreviewScroll event, is raised if the scrollbar has moved. |
| SetHttpTransferBufferSize | Changes the packet size used for transferring data by the DisplayFromHTTP(String,String,String) and DisplayFromFTP(String,String,String) methods. The initial value is 4096. |
| SetItemMenuCaption | Changes 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. |
| SetRectCoordinatesOnDocumentInch | Determines 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. |
| SetRectCoordinatesOnDocumentPixel | Determines 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. |
| SetRectCoordinatesOnViewerPixel | Determines 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. |
| SetRegionBorderColor | Sets 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. |
| SetRegionBorderWidth | Sets 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. |
| SetRegionColor | Sets 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. |
| SetRegionColorSelection | 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. 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. |
| SetRegionEditable | Specifies 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. |
| SetRegionFillMode | Sets 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. |
| SetRegionHeight | Sets 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. |
| SetRegionLeft | Sets 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. |
| SetRegionName | Sets 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. |
| SetRegionPage | Sets 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. |
| SetRegionSelected | Sets 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. You can determine the selection of each highlighted region using the GetRegionSelected method. You can also benefit from using the RegionSelected event, respectively the PreviewRegionSelected event. |
| SetRegionTop | Sets 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. |
| SetRegionWidth | Sets 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. |
| SetResourceReference | (Inherited from System.Windows.FrameworkElement) |
| SetScrollBarsPosition | Sets 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. |
| SetValue | Overloaded. (Inherited from System.Windows.DependencyObject) |
| SetVerticalScrollBarPosition | Sets 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 Scroll event, respectively the PreviewScroll event, is raised if the scrollbar has moved. |
| TagCount | Returns 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. |
| TagGetID | Returns 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. |
| TagGetName | Returns a string representation of a unique predefined tag name of the required tag, that is embedded within the document displayed in the GdViewer control. |
| TagGetValueString | Returns a string representation of the current tag value of the required tag, that is embedded within the document displayed in the GdViewer control. |
| TerminateLastAnnotInteractiveAdd | Asks the GdViewer control to terminate the ongoing interactive annotation creation.
This method only works when the editing mode for annotations is enabled; otherwise, the method will fail. |
| ToString | (Inherited from System.Windows.Controls.Control) |
| TransformToAncestor | Overloaded. (Inherited from System.Windows.Media.Visual) |
| TransformToDescendant | (Inherited from System.Windows.Media.Visual) |
| TransformToVisual | (Inherited from System.Windows.Media.Visual) |
| TranslatePoint | (Inherited from System.Windows.UIElement) |
| TryFindResource | (Inherited from System.Windows.FrameworkElement) |
| UnregisterName | (Inherited from System.Windows.FrameworkElement) |
| UpdateDefaultStyle | (Inherited from System.Windows.FrameworkElement) |
| UpdateLayout | (Inherited from System.Windows.UIElement) |
| ZoomDocumentArea | Adjusts 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. |
| ZoomIN | Increases 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. |
| ZoomOUT | Decreases 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. |
| ZoomRect | Adjusts the current zoom to the area covered by the specified rectangle of selection. You can use the IsRect method to determine if any rectangle of selection is defined.
The viewer control is subsequently refreshed to zoom on the defined rectangle. |
In This Topic
GdViewer Class Methods
In This Topic
For a list of all members of this type, see GdViewer members.
Public Methods
See Also