GdPicture.NET.14
GdPicture14 Namespace / GdViewer Class

In This Topic
GdViewer Class Properties
In This Topic

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

Public Properties
 NameDescription
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertySpecifies if a user is able to drag-and-drop files from the file explorer directly to the control, for example using the mouse.

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

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

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

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

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

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

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

 
Public Property (Inherited from System.Windows.Forms.UserControl)
Public Property (Inherited from System.Windows.Forms.UserControl)
Public Property (Inherited from System.Windows.Forms.UserControl)
Public PropertyOverridden.   
Public Property (Inherited from System.Windows.Forms.UserControl)
Public Property (Inherited from System.Windows.Forms.Control)
Public Property Specifies if GdPicture/XMP annotations must be clipped to page bounds. Default value is true.  
Public Property Specifies if region areas must be clipped to page bounds. Default value is false.  
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertyDetermines whether the GdViewer control display pages in the multipage document continuously one below another when the user scrolls the current page.

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

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

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

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

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

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

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

 
Public PropertySpecifies if borders are to be drawn around the pages displayed in the GdViewer control, for example, to provide the contrast between the page background and the control background.

You can define the page border's color and its size as well.

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

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

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

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

 
Public Property Specifies if fuzzy match is activated during any text search operation. When enabled, a text search operation searches for text that matches a term closely instead of exactly.  
Public PropertySpecifies whether the GdViewer control uses the color correction technique when manipulating with files that embed an ICC profile.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 
Public Property (Inherited from System.Windows.Forms.Control)
Public PropertyGets or sets the page border color of the page borders, which are drawn around the pages displayed in the GdViewer control. This property is only meanigful when the page borders are enabled using the GdViewer.DrawPageBorders property.  
Public PropertyGets or sets the page border size (the border width), in pixels, of the page borders, which are drawn around the pages displayed in the GdViewer control. This property is only meanigful when the page borders are enabled using the GdViewer.DrawPageBorders property.  
Public PropertyGets the total number of pages in the document currently displayed in the GdViewer control.  
Public PropertyGets or sets the current page display mode of the GdViewer control.

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

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

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

The GdViewer.PdfFileNavigation event is raised before displaying the linked file.

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

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

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

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

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

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

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

 
Public PropertySpecifies if the GdViewer control is responsible to check digital certificate when rendering a PDF document containing a digital signature. Depending on the outcome of the certificate audit, the visible appearance associated with each digital signature contained in the displayed document is adjusted.  
Public Property Indicates whether the view rotation applied to the pages of the document must be applied to the file produced by the SaveDocumentToTIFF and SaveDocumentToPDF methods.  
Public PropertyGets or sets the border color of the rectangle of area selection, that is related to the document currently displayed in the GdViewer control. This color is used when drawing the rectangle of selection within the control.

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

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

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

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

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

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

Highlighted regions for currently displayed document are identified and created when searching text, for example using the GdViewer.SearchText method or the second similar overloaded method as well. You can also define highlighted regions directly using GdViewer.AddRegion or GdViewer.AddRegionInches methods.

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

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

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

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

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

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

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

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

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

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

 
Public PropertyGets or sets the zoom step, that specifies the percentage of increasing or decreasing the current zoom factor when using the GdViewer.ZoomIN and the GdViewer.ZoomOUT methods. The value of 25 represents the 25% step, the value of 10 represents the 10% step, etc.  
Top
See Also