Reference Guide
GdPicture14.WEB Namespace / DocuVieware Class
Properties Methods Events

In This Topic
    DocuVieware Class Members
    In This Topic

    The following tables list the members exposed by DocuVieware.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyGets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
    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 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 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 PropertyDefault image alignment within the viewer when the area of the viewer is smaller than the displayed document in its current zoom configuration.
    Setting this property to DocumentAlignmentTopLeft has the effect to display the most top-left part of the displayed page during "Zoom In" operations.  
    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 PropertyGets or sets a value indicating whether the Web server control is enabled. (Inherited from System.Web.UI.WebControls.WebControl)
    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 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 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 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 text selection is permitted.  
    Public Property Specifies whether the selected text context menu options should contain annotations entries.  
    Public PropertyGets or sets a value indicating whether themes apply to this control. (Inherited from System.Web.UI.WebControls.WebControl)
    Public Property Specifies whether the thumbnails can be moved by drag and drop.  
    Public Property Specifies whether the TWAIN acquisition button shall be enabled.  
    Public PropertyGets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from System.Web.UI.Control)
    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 Specifies the protocol of communication used by the application hosting the DocuVieware control. By default DocuVieware tries to determine if the application is running in http or https protocol. If the application is known to be run in HTTPS mode this property should be switched to true.  
    Public Property Specifies whether the viewer shall always show scrollbars.  
    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 PropertyOverridden. Gets or sets the height of the Web server control.  
    Public PropertyOverridden. Gets or sets the programmatic identifier assigned to the server control.  
    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 Specifies the way that pages of a document are preloaded.  
    Public Property Specifies the current page rotation 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 Specifies the rotation mode associated with the rotation button group.  
    Public PropertySpecifies whether scrollbars can be displayed or not within the viewer.
     
    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 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 PropertySpecifies whether the viewer displays only one page at once.
    When set to false, the viewer displays multiple document pages on the screen at the same time.  
    Public PropertyGets or sets the skin to apply to the control. (Inherited from System.Web.UI.WebControls.WebControl)
    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 PropertyGets or sets the tab index of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
    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 PropertySpecifies 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 PropertyGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
    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 PropertyGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from System.Web.UI.Control)
    Public Property Specifies the viewer area background color.  
    Public Property Specifies the current rotation of the control.  
    Public PropertyGets or sets the view-state mode of this control. (Inherited from System.Web.UI.Control)
    Public PropertyGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from System.Web.UI.Control)
    Public PropertyOverridden. Gets or sets the width of the Web server control.  
    Public Property Specifies the current factor of zoom applied during page rendering operations: 1 for 100%, 1.5 for 150%, 2 for 200%...  
    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 MethodOverloaded.  Adds a custom snap-in to the control.  
    Public MethodCopies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
    Public MethodApplies the style properties defined in the page style sheet to the control. (Inherited from System.Web.UI.Control)
    Public Method Burns the annotations on the current document.  
    Public Method Closes the displayed document.  
    Public MethodCopies the properties not encapsulated by the System.Web.UI.WebControls.WebControl.Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
    Public Method Changes the displayed page of the current multipage document.  
    Public MethodOverridden. Enables a server control to perform final clean up before it is released from memory.  
    Public MethodSets input focus to a control. (Inherited from System.Web.UI.Control)
    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 data.  
    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 MethodOverloaded. Gets the URL that corresponds to a set of route parameters. (Inherited from System.Web.UI.Control)
    Public Method Returns the identifier of the session that belong the the DocuVieware object.  
    Public MethodReturns the prefixed portion of the System.Web.UI.Control.UniqueID property of the specified control. (Inherited from System.Web.UI.Control)
    Public MethodDetermines if the server control contains any child controls. (Inherited from System.Web.UI.Control)
    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  
    Public Method Displays a document from a GdPicture Image.  
    Public Method Displays a PDF document from a GdPicturePDF object  
    Public MethodOverloaded.  Displays document from a Stream object.  
    Public MethodOverloaded.  Displays document from an URI.  
    Public MethodCopies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
    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 Call this method to reload the current page annotations on the client side.  
    Public MethodRenders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
    Public MethodRenders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
    Public MethodGets a URL that can be used by the browser. (Inherited from System.Web.UI.Control)
    Public MethodConverts a URL into one that is usable on the requesting client. (Inherited from System.Web.UI.Control)
    Public Method Rotates clockwise or flips the current page of the displayed document.  
    Public Method Rotates clockwise or flips the global view.  
    Public Method Saves the document's annotations into a stream.  
    Public MethodOverloaded.  Saves a copy of the native document as PDF.  
    Public MethodOverloaded.  Saves a copy of the native document as TIFF.  
    Public MethodAssigns an event handler delegate to render the server control and its content into its parent control. (Inherited from System.Web.UI.Control)
    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
    Public Events
     NameDescription
    Public EventOccurs when the server control binds to a data source. (Inherited from System.Web.UI.Control)
    Public EventOccurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from System.Web.UI.Control)
    Public EventOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from System.Web.UI.Control)
    Public EventOccurs when the server control is loaded into the System.Web.UI.Page object. (Inherited from System.Web.UI.Control)
    Public EventOccurs after the System.Web.UI.Control object is loaded but prior to rendering. (Inherited from System.Web.UI.Control)
    Public EventOccurs when the server control is unloaded from memory. (Inherited from System.Web.UI.Control)
    Top
    See Also