DocuVieware Reference Guide
DocuVieware Class Members
Properties  Methods  Events

GdPicture12.WEB Namespace : DocuVieware Class

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 Selected and active elements stroke color.  
Public PropertySpecifies extensions of the allowed formats for export. Each extension must be separated by a coma.
Wildcarrd 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 if printing is allowed.  
Public Property Specifies if file upload is allowed.  
Public Property Specifies if GdPicture/XMP annotations are rendered with a drop shadow effect.  
Public PropertySpecifies the editor mode for the GdPicture/XMP annotation support.
Setting true permits the end user to edit available GdPicture/XMP annotations. Setting false locks all annotations.  
Public PropertySpecifies the path of the cache folder, if any.
If available, the cache folder will be used to store large data blob.
It is highly recommended to setup such folder otherwise all data will be cached into the server memory.
 
Public Property Specifies whether then Snap-in panel is collapsed or not.  
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 informations 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 should be enabled or not while user is drawing a free hand annotation.
This property is effective only if EnableGdPictureAnnotations = 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 PropertySpecifies if the control needs to embed jQuery library.
It is suggested to set this property to false if your page is already referencing it.  
Public PropertySpecifies whether the action buttons should be enabled or not when an annotation is selected.
This property is effective only if EnableGdPictureAnnotations = True.  
Public PropertySpecifies whether the connected line annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public PropertyGets or sets a value indicating whether the Web server control is enabled. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertySpecifies whether the ellipse annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public Property Specifies whether the open button should be enabled or not.  
Public Property Specifies whether the fit page button should be enabled or not.  
Public Property Specifies whether the fit width button should be enabled or not.  
Public Property Specifies whether form fields can be edited into the client browser or not.  
Public PropertySpecifies whether the freehand annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public PropertySpecifies whether the freehand highlighter annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public Property Specifies whether the fullscreen button should be enabled or not.  
Public Property Specifies if GdPicture/XMP annotations support is activated.  
Public PropertySpecifies whether the line annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public PropertySpecifies whether the line arrow annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public Property Specifies whether the open from uri button should be enabled or not.  
Public Property Specifies whether the marquee zoom mode button should be enabled or not.  
Public Property Specifies whether the mouse mode button group should be enabled or not.  
Public Property Specifies if multiple thumbnails selection is allowed. Holding Ctrl key during selection allows to select multiple pages.  
Public Property Specifies whether the navigation button group should be enabled or not.  
Public Property Specifies whether the page view mode button should be enabled or not.  
Public Property Specifies whether the pan mode button should be enabled or not.  
Public PropertySpecifies whether the ruler annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public Property Specifies whether the print button should be enabled or not.  
Public PropertySpecifies whether the rectangle annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public PropertySpecifies whether the rectangle highlighter annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public Property Specifies whether the rotation button group should be enabled or not.  
Public PropertySpecifies whether the rubber stamp annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public PropertySpecifies whether the ruler annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public Property Specifies whether the save button should be enabled or not.  
Public Property Specifies whether the select mode button should be enabled or not.  
Public PropertySpecifies whether the sticky note annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public PropertySpecifies whether the text annotation button should be enabled or not.
This property is effective only if EnableGdPictureAnnotations = True  
Public Property Specifies if text selection is permitted. Holding Alt key during selection permits to switch to column selection mode instead of the default line selection mode.  
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 or not.  
Public Property Specifies whether the TWAIN acquisition button should be enabled or not.  
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 should be enabled or not.  
Public Property Specifies whether the zoom button group should be enabled or not.  
Public Property Turn this property to True to force the viewer to always show scrollbars.  
Public PropertySpecifies whether the drawing mode for freehand annotation is multi line or not.
This property is effective only if EnableGdPictureAnnotations = 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 the download size limit, in bytes.  
Public Property Specifies the maximum of pages per loaded document.  
Public Property Specifies the upload size limit, in bytes.  
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 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 rotation mode associated with the rotation button group.  
Public PropertySpecifies if scrollbars can be displayed or not within the viewer.
If true, scrollbars appears when the area to render is larger than the control.  
Public Property Specifies whether the annotations SnapIn is enabled or not.  
Public Property Specifies whether the Bookmarks SnapIn is enabled or not.  
Public Property Specifies whether the Snap-in button strip is displayed or not.  
Public Property Specifies whether the button that collapses the Snap-in pannel is displayed or not.  
Public Property Specifies whether the header of the Snap-in pannel is displayed or not.  
Public Property Specifies whether the text search SnapIn is enabled or not.  
Public Property Specifies whether the Thumbnails SnapIn is enabled or not.  
Public Property Specifies whether the Toolbar are visible or not.  
Public PropertySpecifies if 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 Snap-in panel default width  
Public PropertySpecifies if DocuVieware is hosted in a single server or in a Server Farm with sticky sessions (also known as session affinity).
To maximize performances, it is highly recommended to keep this property to true in the context of single server or Server Farm with sticky sessions hosting.  
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 result 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.
Use -1 to force the control to use the ASP.NET session mechanism, otherwise a value superior or equal to 1 is required.  
Public Property Viewer Toolbar Background Color.  
Public Property The space between each button of the toolbar, in pixels.  
Public Property The height of the toolbar, in pixels.  
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 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 Viewer area background color.  
Public Property 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 The current factor of zoom applied during page rendering operations: 1 for 100%, 1.5 for 150%, 2 for 200%...  
Public Property Zoom mode used by the viewer.  
Public Property Defines the percentage of increasing or decreasing of the 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 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 MethodBinds a data source to the invoked server control and all its child controls. (Inherited from System.Web.UI.Control)
Public Method Changes the displayed page of the current multipage document.  
Public MethodEnables a server control to perform final clean up before it is released from memory. (Inherited from System.Web.UI.Control)
Public Method (Inherited from System.Web.UI.Control)
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 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 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 MethodOverloaded.  Outputs the DocuVieware control content to a provided System.IO.TextWriter object.  
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 Increases the current level of zoom.  
Public Method Decreases the current level of zoom.  
Top
Public Events
 NameDescription
Public Event Specifies the event handler for custom actions.  
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 Event Specifies the event handler for a new loaded document.  
Public Event Specifies that a page is ready to be transfered to the client side.  
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

Reference

DocuVieware Class
GdPicture12.WEB Namespace