Reference Guide
GdPicture14.WEB Namespace / DocuViewareControl Class
Properties Methods

In This Topic
    DocuViewareControl Class Members
    In This Topic

    The following tables list the members exposed by DocuViewareControl.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public Property Specifies the selected and active elements stroke color.  
    Public Property Specifies custom headers for the generated AJAX requests. Value must be a (properly escaped) JSON-formatted string. Default value is null.  
    Public Property Specifies the default timeout, in milliseconds, for the generated AJAX requests.  
    Public PropertySpecifies extensions of the allowed formats for export. Each extension must be separated by a coma.
    Wildcard character '*' can be used to specify any supported format.
    The following extensions are currently supported: "PDF", "TIFF".
    For example use "*" to allow all supported format for export, "PDF" to allow only PDF export and "PDF,TIFF" to allow PDF and TIFF export.  
    Public Property Specifies whether printing is allowed.  
    Public Property Specifies whether file upload is allowed.  
    Public Property Specifies whether GdPicture/XMP annotations are rendered with a drop shadow effect.  
    Public Property Specifies the editor mode for the GdPicture/XMP annotation support.  
    Public Property Specifies the orientation mode for a newly added annotation.  
    Public Property Gets the client identifier assigned to the DocuviewareControl instance.  
    Public Property Specifies whether the Snap-in panel is collapsed or not.  
    Public Property Specifies whether the Snap-in panel should be automatically collapsed when the displayed document is closed.  
    Public Property Current page of the displayed document, starts from 1 (Read-Only).  
    Public PropertyCustom error notification icon.
    Used to specify a custom icon within errors notification boxes.  
    Public PropertyCustom info notification icon.
    Used to specify a custom icon within information notification boxes.  
    Public PropertyCustom success notification icon.
    Used to specify a custom icon within success notification boxes.  
    Public PropertyCustom question notification icon.
    Used to specify a custom icon within questions notification boxes.  
    Public PropertyCustom warning notification icon.
    Used to specify a custom icon within warnings notification boxes.  
    Public PropertySpecifies whether the drawing mode panel shall be enabled while user is drawing a free hand annotation.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public Property Specifies whether printing support is disabled for annotations.  
    Public Property Default image alignment within the viewer when the area of the viewer is smaller than the displayed document in its current zoom configuration.  
    Public Property Default page position within the viewer when the rendering area of the displayed document in its current zoom configuration is smaller than the area of the viewer.  
    Public Property Specifies if the DocuViewareControl instance has the adaptive raster cache enabled.  
    Public PropertySpecifies whether the action buttons shall be enabled when an annotation is selected.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public PropertySpecifies whether the connected line annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public Property Specifies whether documents drag & drop is allowed into the viewer area.  
    Public PropertySpecifies whether the ellipse annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public Property Specifies if attached files of loaded documents can be retrieved and exported by the application users.  
    Public Property Specifies whether the open button shall be enabled.  
    Public Property Specifies whether the 'Fit Page' button shall be enabled.  
    Public Property Specifies whether the fit width button shall be enabled.  
    Public Property Specifies whether form fields can be edited into the client browser or not.  
    Public PropertySpecifies whether the freehand annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public PropertySpecifies whether the freehand highlighter annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public Property Specifies whether the fullscreen button shall be enabled.  
    Public Property Specifies whether GdPicture/XMP annotations support is activated.  
    Public PropertySpecifies whether the line annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public PropertySpecifies whether the line arrow annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public PropertySpecifies whether the link annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public Property Specifies whether a rectangle is rendered when a link is hovered in the loaded document.  
    Public Property Specifies whether the 'open from uri' button shall be enabled.  
    Public Property Specifies whether the marquee zoom mode button shall be enabled.  
    Public Property Specifies whether the mouse mode button group shall be enabled.  
    Public Property Specifies whether multiple thumbnails selection is allowed.  
    Public Property Specifies whether the navigation button group shall be enabled.  
    Public Property Specifies whether the page view mode button shall be enabled.  
    Public Property Specifies whether the pan mode button shall be enabled.  
    Public PropertySpecifies whether the ruler annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public Property Specifies whether the print button shall be enabled.  
    Public Property Specifies whether the print to pdf option shall be enabled.  
    Public PropertySpecifies whether the rectangle annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public PropertySpecifies whether the rectangle highlighter annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public Property Specifies whether the selected text contextual menu options should contain the remove text entry.  
    Public Property Specifies whether the rotation button group shall be enabled.  
    Public PropertySpecifies whether the rubber stamp annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public PropertySpecifies whether the ruler annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public Property Specifies whether the save button shall be enabled.  
    Public Property Specifies whether the selected text annotations shall be editable.  
    Public Property Specifies whether the select mode button shall be enabled.  
    Public PropertySpecifies whether the sticky note annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public PropertySpecifies whether the text annotation button shall be enabled.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public Property Specifies whether the selected text contextual menu options should contain the text copy entry.  
    Public Property Specifies whether text selection is permitted.  
    Public Property Specifies whether the selected text contextual menu options should contain annotations entries.  
    Public Property Specifies whether remove page button is displayed into the thumbnails snap-in.  
    Public Property Specifies whether the thumbnails can be moved by drag and drop.  
    Public Property Specifies whether rotate page buttons are displayed into the thumbnails snap-in.  
    Public Property Specifies whether the TWAIN acquisition button shall be enabled.  
    Public Property Specifies whether the fit original size button shall be enabled.  
    Public Property Specifies whether the zoom button group shall be enabled.  
    Public Property  
    Public Property Forces scrollbars visibility.  
    Public PropertySpecifies whether the drawing mode for freehand annotation is multi line or not.
    This property is only effective if EnableGdPictureAnnotations is set to true.  
    Public Property Specifies the color used in both dialogs and snap-ins headers.  
    Public Property  
    Public Property Returns if the horizontal scrollbar is visible or not.  
    Public Property  
    Public Property Specifies the way link annotations react to clicks.  
    Public Property Specifies the default timeout, in milliseconds, allowed for each document loading process.  
    Public Property Specifies the user preference information related to the user's language.  
    Public Property Specifies, in bytes, the download size limit.  
    Public Property Specifies the maximum of pages per loaded document.  
    Public Property Specifies, in bytes, the upload size limit.  
    Public Property Specifies the color used to define dropdowns borders, buttons separators, line separators.  
    Public Property Specifies the zoom mode to set when a new document is loaded.  
    Public Property Specifies the default packet size during data transfer operations, in bytes.  
    Public Property Number of pages in the displayed document (Read-Only).  
    Public Property Default value is PageDisplayMode.MultiplePagesView.  
    Public Property Height, in inches, of the current page of the displayed document.  
    Public Property Specifies the way that pages of a document are preloaded.  
    Public Property Specifies the current page rotation of the displayed document.  
    Public Property Width, in inches, of the current page of the displayed document.  
    Public Property Specifies the color used in both dialogs and snap-ins body background.  
    Public Property Specifies the print quality that DocuVieware uses for the job.  
    Public Property Specifies the maximum number of pixels (vertically or horizontally) that the internal rasterizer is permitted to produce. The higher the value, the higher the maximum zoom will be for displaying non-raster documents (IE: PDF). Default value is -1 (automatically computed).  
    Public Property The combination of PageRotation and ViewRotation that represents the final rendering rotation of the current page.  
    Public Property Specifies the rotation mode associated with the rotation button group.  
    Public Property  
    Public Property Specifies whether the Annotations Comments SnapIn is enabled.  
    Public Property Specifies whether the annotations SnapIn is enabled.  
    Public Property Specifies whether the Bookmarks SnapIn is enabled.  
    Public Property Specifies whether the Digital Signature SnapIn is enabled.  
    Public Property Specifies if the DocuVieware logo is displayed in the toolbar.  
    Public Property Specifies the viewer menu should display with dark theme.  
    Public Property Specifies whether the Redaction SnapIn is enabled.  
    Public Property Specifies whether the Snap-in button strip is displayed or not.  
    Public Property Specifies whether the button that collapses the Snap-in panel is displayed or not.  
    Public Property Specifies whether the header of the Snap-in panel is displayed or not.  
    Public Property Specifies whether the text search SnapIn is enabled.  
    Public Property Specifies whether the Thumbnails SnapIn is enabled.  
    Public Property Specifies whether the Toolbars are visible or not.  
    Public Property Specifies the Snap-in panel default width.  
    Public Property Specifies the color used to stroke viewer elements such borders, toolbar icons and thumbnail text.  
    Public Property Specifies the maximum number of results provided by a text search request.  
    Public Property The height, in pixels, of each thumbnail.  
    Public Property The width, in pixels, of each thumbnail.  
    Public Property Specifies the amount of time, in minutes, allowed between requests before the DocuVieware session-state provider terminates the session.  
    Public Property Specifies the viewer toolbar background color.  
    Public Property The space, in pixels, between each button of the toolbar.  
    Public Property The height, in pixels, of the toolbar.  
    Public Property Specifies the Toolbar style, Desktop, Mobile or Auto.  
    Public Property Specifies the format used to store acquired images.  
    Public PropertySpecifies the bit depth the TWAIN acquisition source should acquire at.
    This property is only effective if TwainSourceSetCustomConfiguration is set to true.  
    Public Property Enables the custom configuration support for the TWAIN source.  
    Public PropertySpecifies whether the TWAIN acquisition source shall enable duplex acquisition.
    This property is only effective if TwainSourceSetCustomConfiguration is set to true.  
    Public PropertySpecifies whether the TWAIN acquisition source shall hide or show the device driver user interface before acquisition.
    This property is only effective if TwainSourceSetCustomConfiguration is set to true.  
    Public PropertySpecifies the resolution the TWAIN acquisition source should acquire at.
    This property is only effective if TwainSourceSetCustomConfiguration is set to true.  
    Public PropertySpecifies whether the TWAIN acquisition source shall acquire from the document feeder or the flatbed.
    This property is only effective if TwainSourceSetCustomConfiguration is set to true.  
    Public Property Returns if the vertical scrollbar is visible or not.  
    Public Property Specifies the viewer area background color.  
    Public Property Specifies the current rotation of the control.  
    Public Property  
    Public Property Specifies the current factor of zoom applied during page rendering operations.  
    Public Property Specifies the zoom mode used by the viewer.  
    Public Property Defines the percentage of increasing or decreasing level of zoom for 'Zoom In' and 'Zoom Out' operations.  
    Top
    Public Methods
     NameDescription
    Public Method Adds a custom snap-in to the control.  
    Public Method Adds a custom button to the main toolbar.  
    Public Method Applies all redaction marks to the native document.  
    Public Method Burns the annotations on the current document.  
    Public Method Closes the displayed document.  
    Public Method Deletes specific pages of the current document.  
    Public Method Changes the displayed page of the current multipage document.  
    Public Method  
    Public Method Returns the number of annotations within the current page or within the entire document.  
    Public Method Provides a copy of the native document's binary data at the opening state.  
    Public Method Returns the name of the displayed document.  
    Public Method Returns the type of the displayed document.  
    Public Method Returns, if any, the last HTTP or FTP transfer error description.  
    Public Method If the native document is a raster (or bitmap), this method provides access to the native GdPicture image used to handle it.  
    Public Method If the native document is a PDF, this method provides access to the native GdPicturePDF object used to handle it.  
    Public Method Returns the identifier of the session that belong the the DocuVieware object.  
    Public Method Returns the type of the displayed document.  
    Public Method Determines if the loaded document has been modified or not.  
    Public Method Load document's annotations from a stream.  
    Public Method Displays a document from an array of bytes.  
    Public Method Displays a document from a file.  
    Public Method Displays a document from a GdPicture Image.  
    Public Method Displays a PDF document from a GdPicturePDF object.  
    Public Method Displays a document from a stream object.  
    Public Method Displays document from an URI.  
    Public Method Call this method to redraw the current page on the client side.  
    Public Method Call this method to redraw specific pages on the client side.  
    Public Method Registers a digital certificate to be subsequently used to apply digital signature to documents.  
    Public Method Call this method to reload the current page annotations on the client side.  
    Public Method Outputs the DocuviewareControl instance content to a provided System.IO.TextWriter object.  
    Public Method Removes all previously added certificates.  
    Public Method Rotates clockwise or flips the current page of the displayed document.  
    Public Method Rotates clockwise or flips specific pages of the displayed document.  
    Public Method Rotates clockwise or flips the global view.  
    Public Method Saves the document's annotations into a stream.  
    Public Method Saves a copy of the native document as PDF.  
    Public Method Saves a copy of the native document as TIFF.  
    Public Method Swaps two specific pages of the current document.  
    Public Method Changes the initial value of a TWAIN capability from a numeric value. This method permits to control any supported capability of the TWAIN acquisition device being selected, through the TWAIN capabilities mechanism.  
    Public Method Changes the initial value of a TWAIN capability from a string value. This method permits to control any supported capability of the TWAIN acquisition device being selected, through the TWAIN capabilities mechanism.  
    Public Method Increases the current level of zoom.  
    Public Method Decreases the current level of zoom.  
    Top
    See Also