Name | Description | |
---|---|---|
DocuVieware Constructor | Overloaded. |
DocuVieware Class Members
In This Topic
The following tables list the members exposed by DocuVieware.
Public Constructors
Public Properties
Name | Description | |
---|---|---|
AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from System.Web.UI.WebControls.WebControl) | |
ActiveSelectedColor | Specifies the selected and active elements stroke color. | |
AjaxCustomHeaders | Specifies custom headers for the generated AJAX requests. Value must be a (properly escaped) JSON-formatted string. Default value is null. | |
AjaxRequestTimeout | Specifies the default timeout, in milliseconds, for the generated AJAX requests. | |
AllowedExportFormats | Specifies 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. | |
AllowPrint | Specifies whether printing is allowed. | |
AllowUpload | Specifies whether file upload is allowed. | |
AnnotationDropShadow | Specifies whether GdPicture/XMP annotations are rendered with a drop shadow effect. | |
AnnotationEditorMode | Specifies the editor mode for the GdPicture/XMP annotation support. | |
AnnotationOrientationMode | Specifies the orientation mode for a newly added annotation. | |
CollapsedSnapIn | Specifies whether the Snap-in panel is collapsed or not. | |
CollapseSnapinOnDocumentClosed | Specifies whether the Snap-in panel should be automatically collapsed when the displayed document is closed. | |
CustomNotificationIconError | Custom error notification icon. Used to specify a custom icon within errors notification boxes. | |
CustomNotificationIconInfo | Custom info notification icon. Used to specify a custom icon within information notification boxes. | |
CustomNotificationIconOk | Custom success notification icon. Used to specify a custom icon within success notification boxes. | |
CustomNotificationIconQuestion | Custom question notification icon. Used to specify a custom icon within questions notification boxes. | |
CustomNotificationIconWarning | Custom warning notification icon. Used to specify a custom icon within warnings notification boxes. | |
DisableAnnotationDrawingModePanel | Specifies 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. | |
DisableAnnotationPrinting | Specifies whether printing support is disabled for annotations. | |
DocumentAlignment | Default 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. | |
DocumentPosition | 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. | |
EnableAdaptiveRasterCache | Specifies if the DocuViewareControl instance has the adaptive raster cache enabled. | |
EnableAnnotationActionButtons | Specifies whether the action buttons shall be enabled when an annotation is selected. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableConnectedLineAnnotationButton | Specifies whether the connected line annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
Enabled | Gets or sets a value indicating whether the Web server control is enabled. (Inherited from System.Web.UI.WebControls.WebControl) | |
EnableDocumentsDrop | Specifies whether documents drag & drop is allowed into the viewer area. | |
EnableEllipseAnnotationButton | Specifies whether the ellipse annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableFileAttachments | Specifies if attached files of loaded documents can be retrieved and exported by the application users. | |
EnableFileUploadButton | Specifies whether the open button shall be enabled. | |
EnableFitPageButton | Specifies whether the 'Fit Page' button shall be enabled. | |
EnableFitWidthButton | Specifies whether the fit width button shall be enabled. | |
EnableFormFieldsEdition | Specifies whether form fields can be edited into the client browser or not. | |
EnableFreehandAnnotationButton | Specifies whether the freehand annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableFreehandHighlighterAnnotationButton | Specifies whether the freehand highlighter annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableFullScreenButton | Specifies whether the fullscreen button shall be enabled. | |
EnableGdPictureAnnotations | Specifies whether GdPicture/XMP annotations support is activated. | |
EnableLineAnnotationButton | Specifies whether the line annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableLineArrowAnnotationButton | Specifies whether the line arrow annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableLinkAnnotationButton | Specifies whether the link annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableLinkRect | Specifies whether a rectangle is rendered when a link is hovered in the loaded document.. | |
EnableLoadFromUriButton | Specifies whether the 'open from uri' button shall be enabled. | |
EnableMarqueeZoomModeButton | Specifies whether the marquee zoom mode button shall be enabled. | |
EnableMouseModeButtons | Specifies whether the mouse mode button group shall be enabled. | |
EnableMultipleThumbnailSelection | Specifies whether multiple thumbnails selection is allowed. | |
EnablePagesNavigationButtons | Specifies whether the navigation button group shall be enabled. | |
EnablePageViewButtons | Specifies whether the page view mode button shall be enabled. | |
EnablePanModeButton | Specifies whether the pan mode button shall be enabled. | |
EnablePolyRulerAnnotationButton | Specifies whether the ruler annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnablePrintButton | Specifies whether the print button shall be enabled. | |
EnablePrintToPDF | Specifies whether the print to pdf option shall be enabled. | |
EnableRectangleAnnotationButton | Specifies whether the rectangle annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableRectangleHighlighterAnnotationButton | Specifies whether the rectangle highlighter annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableRemoveTextItem | Specifies whether the selected text contextual menu options should contain the remove text entry. | |
EnableRotateButtons | Specifies whether the rotation button group shall be enabled. | |
EnableRubberStampAnnotationButton | Specifies whether the rubber stamp annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableRulerAnnotationButton | Specifies whether the ruler annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableSaveButton | Specifies whether the save button shall be enabled. | |
EnableSelectedTextAnnotationEdition | Specifies whether the selected text annotations shall be editable. | |
EnableSelectModeButton | Specifies whether the select mode button shall be enabled. | |
EnableStickyNoteAnnotationButton | Specifies whether the sticky note annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableTextAnnotationButton | Specifies whether the text annotation button shall be enabled. This property is only effective if EnableGdPictureAnnotations is set to true. | |
EnableTextCopyMenuItem | Specifies whether the selected text contextual menu options should contain the text copy entry. | |
EnableTextSelection | Specifies whether text selection is permitted. | |
EnableTextSelectionAnnotation | Specifies whether the selected text contextual menu options should contain annotations entries. | |
EnableTheming | Gets or sets a value indicating whether themes apply to this control. (Inherited from System.Web.UI.WebControls.WebControl) | |
EnableThumbnailDeleteButton | Specifies whether remove page button is displayed into the thumbnails snap-in. | |
EnableThumbnailDragDrop | Specifies whether the thumbnails can be moved by drag and drop. | |
EnableThumbnailRotateButtons | Specifies whether rotate page buttons are displayed into the thumbnails snap-in. | |
EnableTwainAcquisitionButton | Specifies whether the TWAIN acquisition button shall be enabled. | |
EnableViewState | Gets 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) | |
EnableZoom100Button | Specifies whether the fit original size button shall be enabled. | |
EnableZoomButtons | Specifies whether the zoom button group shall be enabled. | |
FileDownloadCustomHeaders | ||
ForceHTTPS | 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. | |
ForceScrollBars | Specifies whether the viewer shall always show scrollbars. | |
FreeHandContinuousDrawingMode | Specifies whether the drawing mode for freehand annotation is multi line or not. This property is only effective if EnableGdPictureAnnotations is set to true. | |
HeaderColor | Specifies the color used in both dialogs and snap-ins headers. | |
Height | Overridden. Gets or sets the height of the Web server control. | |
ID | Overridden. Gets or sets the programmatic identifier assigned to the server control. | |
ImageQuality | ||
LinkAnnotationClickBehaviour | Specifies the way link annotations react to clicks. | |
LoadingTimeout | Specifies the default timeout, in milliseconds, allowed for each document loading process. | |
Locale | Specifies the user preference information related to the user's language. | |
MaxDownloadSize | Specifies, in bytes, the download size limit. | |
MaxPages | Specifies the maximum of pages per loaded document. | |
MaxUploadSize | Specifies, in bytes, the upload size limit. | |
MiscBorderColor | Specifies the color used to define dropdowns borders, buttons separators, line separators. | |
OpenZoomMode | Specifies the zoom mode to set when a new document is loaded. | |
PacketSize | Specifies the default packet size during data transfer operations, in bytes. | |
PagePreload | Specifies the way that pages of a document are preloaded. | |
PageRotation | Specifies the current page rotation of the displayed document. | |
PanelBackColor | Specifies the color used in both dialogs and snap-ins body background. | |
PrintDefaultPageRange | Specifies the initial page range selected into the printing dialog box. | |
PrintQuality | Specifies the print quality that DocuVieware uses for the job. | |
RasterizerPixelSizeLimit | Specifies the maximum number of pixels 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). | |
RenderRotation | The combination of PageRotation and ViewRotation that represents the final rendering rotation of the current page. | |
RotateButtonsMode | Specifies the rotation mode associated with the rotation button group. | |
SaveDefaultPageRange | Specifies the initial page range selected into the document saving dialog box. | |
ScrollBars | Specifies whether scrollbars can be displayed or not within the viewer. | |
ScrollbarStyle | Specifies the appearance of the scrollbars. | |
ShowAnnotationsCommentsSnapIn | Specifies whether the Annotations Comments SnapIn is enabled. | |
ShowAnnotationsSnapIn | Specifies whether the annotations SnapIn is enabled. | |
ShowBookmarksSnapIn | Specifies whether the Bookmarks SnapIn is enabled. | |
ShowDigitalSignatureSnapIn | Specifies whether the Digital Signature SnapIn is enabled. | |
ShowLoadingSpinner | Specifies if the loading spinner is displayed while an action is pending. | |
ShowLogo | Specifies if the DocuVieware logo is displayed in the toolbar. | |
ShowRedactionSnapIn | Specifies whether the Redaction SnapIn is enabled. | |
ShowSnapInButtonStrip | Specifies whether the Snap-in button strip is displayed or not. | |
ShowSnapInCollapseButton | Specifies whether the button that collapses the Snap-in panel is displayed or not. | |
ShowSnapInPanelHeader | Specifies whether the header of the Snap-in panel is displayed or not. | |
ShowTextSearchSnapIn | Specifies whether the text search SnapIn is enabled. | |
ShowThumbnailsSnapIn | Specifies whether the Thumbnails SnapIn is enabled. | |
ShowToolbar | Specifies whether the Toolbars are visible or not. | |
SinglePageView | Specifies 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. | |
SkinID | Gets or sets the skin to apply to the control. (Inherited from System.Web.UI.WebControls.WebControl) | |
SnapInPanelDefaultWidth | Specifies the Snap-in panel default width. | |
SnapInSplitterBarColor | Specifies the color used as background for the snapIn splitter bar. | |
StrokeColor | Specifies the color used to stroke viewer elements such borders, toolbar icons and thumbnail text. | |
TabIndex | Gets or sets the tab index of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl) | |
TextSearchMaxResults | Specifies the maximum number of results provided by a text search request. | |
ThumbnailHeight | The height, in pixels, of each thumbnail. | |
ThumbnailWidth | The width, in pixels, of each thumbnail. | |
Timeout | Specifies the amount of time, in minutes, allowed between requests before the DocuVieware session-state provider terminates the session. | |
ToolbarBackColor | Specifies the viewer toolbar background color. | |
ToolbarButtonsSpacing | The space, in pixels, between each button of the toolbar. | |
ToolbarHeight | The height, in pixels, of the toolbar. | |
ToolbarStyle | Specifies the Toolbar style, Desktop, Mobile or Auto. | |
ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from System.Web.UI.WebControls.WebControl) | |
TwainAcquisitionFormat | Specifies the format used to store acquired images. | |
TwainSourceBitDepth | Specifies the bit depth the TWAIN acquisition source should acquire at. This property is only effective if TwainSourceSetCustomConfiguration is set to true. | |
TwainSourceEnableCustomConfiguration | Enables the custom configuration support for the TWAIN source. | |
TwainSourceEnableDuplex | Specifies whether the TWAIN acquisition source shall enable duplex acquisition. This property is only effective if TwainSourceSetCustomConfiguration is set to true. | |
TwainSourceHideUI | Specifies 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. | |
TwainSourceResolution | Specifies the resolution the TWAIN acquisition source should acquire at. This property is only effective if TwainSourceSetCustomConfiguration is set to true. | |
TwainSourceSelectFeeder | Specifies 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. | |
UserInterfaceTheme | Specifies the colors and styles of the DocuVieware control. | |
ValidateRequestMode | Gets 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) | |
ViewerBackColor | Specifies the viewer area background color. | |
ViewRotation | Specifies the current rotation of the control. | |
ViewStateMode | Gets or sets the view-state mode of this control. (Inherited from System.Web.UI.Control) | |
Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from System.Web.UI.Control) | |
Width | Overridden. Gets or sets the width of the Web server control. | |
Zoom | Specifies the current factor of zoom applied during page rendering operations: 1 for 100%, 1.5 for 150%, 2 for 200%... | |
ZoomMode | Specifies the zoom mode used by the viewer. | |
ZoomStep | Defines the percentage of increasing or decreasing level of zoom for 'Zoom In' and 'Zoom Out' operations. |
Public Methods
Name | Description | |
---|---|---|
AddCustomSnapIn | Overloaded. Adds a custom snap-in to the control. | |
AddCustomToolbarButton | Adds a custom button to the main toolbar. | |
ApplyAllRedactions | Applies all redaction marks to the native document. | |
ApplyStyle | Copies 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) | |
ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from System.Web.UI.Control) | |
BurnAnnotations | Burns the annotations on the current document. | |
Close | Closes the displayed document. | |
CopyBaseAttributes | Copies 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) | |
DataBind | Binds a data source to the invoked server control and all its child controls. (Inherited from System.Web.UI.Control) | |
DeletePages | Deletes specific pages of the current document. | |
DisplayPage | Changes the displayed page of the current multipage document. | |
Dispose | Overridden. Enables a server control to perform final clean up before it is released from memory. | |
FindControl | (Inherited from System.Web.UI.Control) | |
Focus | Sets input focus to a control. (Inherited from System.Web.UI.Control) | |
GetAnnotationCount | Returns the number of annotations within the current page or within the entire document. | |
GetDocumentData | Provides a copy of the native document's binary data at the opening state. | |
GetDocumentName | Returns the name of the displayed document. | |
GetDocumentType | Returns the type of the displayed document. | |
GetDocuViewareControl | Returns the DocuViewareControl object that belongs to this DocuVieware object. | |
GetLastTransferError | Returns, if any, the last HTTP or FTP transfer error description. | |
GetNativeImage | If the native document is a raster (or bitmap), this method provides access to the native GdPicture image used to handle it. | |
GetNativePDF | If the native document is a PDF, this method provides access to the native GdPicturePDF object used to handle it. | |
GetPageRotation | Returns the rotation of a page of the displayed document. | |
GetRouteUrl | Overloaded. Gets the URL that corresponds to a set of route parameters. (Inherited from System.Web.UI.Control) | |
GetSessionID | Returns the identifier of the session that belong the the DocuVieware object. | |
GetUniqueIDRelativeTo | Returns the prefixed portion of the System.Web.UI.Control.UniqueID property of the specified control. (Inherited from System.Web.UI.Control) | |
HasControls | Determines if the server control contains any child controls. (Inherited from System.Web.UI.Control) | |
HasModifiedDocument | Determines if the loaded document has been modified or not. | |
LoadAnnotations | Load document's annotations from a stream. | |
LoadFromByteArray | Displays a document from an array of bytes. | |
LoadFromFile | ||
LoadFromGdPictureImage | Displays a document from a GdPicture Image. | |
LoadFromGdPicturePDF | Displays a PDF document from a GdPicturePDF object | |
LoadFromStream | Overloaded. Displays document from a Stream object. | |
LoadFromURI | Overloaded. Displays document from an URI. | |
MergeStyle | Copies 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) | |
RedrawPage | Call this method to redraw the current page on the client side. | |
RedrawPages | Call this method to redraw specific pages on the client side. | |
RegisterCertificate | Registers a digital certificate to be subsequently used to apply digital signature to documents. | |
ReloadAnnotations | Call this method to reload the current page annotations on the client side. | |
RenderBeginTag | Renders 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) | |
RenderControl | Overloaded. Outputs the DocuVieware control content to a provided System.IO.TextWriter object. | |
RenderEndTag | Renders 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) | |
ResetCertificates | Removes all previously added certificates. | |
ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from System.Web.UI.Control) | |
ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from System.Web.UI.Control) | |
RotatePage | Rotates clockwise or flips the current page of the displayed document. | |
RotatePages | Rotates clockwise or flips specific pages of the displayed document. | |
RotateView | Rotates clockwise or flips the global view. | |
SaveAnnotations | Saves the document's annotations into a stream. | |
SaveAsPDF | Saves a copy of the native document as PDF. | |
SaveAsTIFF | Saves a copy of the native document as TIFF. | |
SetRenderMethodDelegate | Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from System.Web.UI.Control) | |
SwapPages | Swaps two specific pages of the current document. | |
TwainSetCapCurrentNumeric | 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. | |
TwainSetCapCurrentString | 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. | |
ZoomIN | Increases the current level of zoom. | |
ZoomOUT | Decreases the current level of zoom. |
Public Events
Name | Description | |
---|---|---|
DataBinding | Occurs when the server control binds to a data source. (Inherited from System.Web.UI.Control) | |
Disposed | Occurs 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) | |
Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from System.Web.UI.Control) | |
Load | Occurs when the server control is loaded into the System.Web.UI.Page object. (Inherited from System.Web.UI.Control) | |
PreRender | Occurs after the System.Web.UI.Control object is loaded but prior to rendering. (Inherited from System.Web.UI.Control) | |
Unload | Occurs when the server control is unloaded from memory. (Inherited from System.Web.UI.Control) |
See Also