WebDocumentViewerBaseJS Class Members

In This Topic

The following tables list the members exposed by WebDocumentViewerBaseJS.

Public Constructors

	Name	Description
	WebDocumentViewerBaseJS	Initializes a new instance of the WebDocumentViewerBaseJS class.

Methods

	Name	Description
	addFile	Overloaded. Sends an asynchronous request to a server, gets information (without file authentication) about images, which are stored in file on server and adds images to the web document viewer.
	addFileWithAuthentication	Overloaded. Sends an asynchronous request to a server, gets information (with file authentication) about images, which are stored in file on server and adds images to the web document viewer.
	authenticateFile	Overloaded. Sends an asynchronous request to authenticate a file with password.
	clearCurrentVisualTool	Clears the current visual tool of the document viewer.
	clearSessionCache	Clears cache for current HTTP session.
	downloadFile	Overloaded. Downloads a file from server.
	exportAndDownloadFile	Overloaded. Exports images (with annotations), which are loaded in web image viewer, to a file and downloads the file.
	exportFile	Overloaded. Exports images (with annotations), which are loaded in web image viewer, to a file.
	failAsyncOperation	Overloaded. Fires "asyncOperationFailed" event. (Inherited from WebUiControlJS)
	finishAsyncOperation	Overloaded. Fires "asyncOperationFinished" event. (Inherited from WebUiControlJS)
	get_Clipboard	Gets a clipboard object for this document viewer.
	get_ContainerId	Gets an identifier of DOM-element that contains this control. (Inherited from WebUiControlJS)
	get_CurrentUser	Gets the current user.
	get_CurrentVisualTool	Gets the current visual tool of the document viewer. Combination of "current visual tool" and "mandatory visual tool" is used as current visual tool in image viewer.
	get_DocumentLayoutSettings	Gets a document layout settings.
	get_ImageViewer	Gets an image viewer, which is associated with this document viewer.
	get_Items	Gets the collection of UI elements contained within this WebDocumentViewerBaseJS. (Inherited from WebUiControlJS)
	get_LocalizationId	Gets the localization identifier of UI element.
	get_MandatoryVisualTool	Gets the mandatory visual tool of the document viewer. Combination of "current visual tool" and "mandatory visual tool" is used as current visual tool in image viewer.
	get_OpenedFileId	Gets an identifier of file that was previously opened using the WebDocumentViewerBaseJS.openFile or WebDocumentViewerBaseJS.openFileWithAuthentication function.
	get_ThumbnailViewer	Gets a thumbnail viewer, which is associated with this document viewer.
	getAllRegisteredVisualToolIds	Returns all identifiers of registered visual tools.
	getAllStandardRegisteredVisualToolIds	Returns identifiers of "standard" registered WebVisualToolJS.
	getFocusedIndex	Returns the index of focused image.
	getImages	Returns an image collection, which is associated with the document viewer.
	getNestedElements	Returns array of nested UI elements. (Inherited from WebUiControlJS)
	getVisualToolById	Returns visual tool by ID of the visual tool type.
	gotoNextPage	Navigates an image viewer to the next image.
	gotoPage	Navigates an image viewer to the specified image.
	gotoPreviousPage	Navigates an image viewer to the previous image.
	openFile	Overloaded. Sends an asynchronous request to a server, gets information (without file authentication) about images, which are stored in file on server, clears the web document viewer and adds images to the web document viewer.
	openFileWithAuthentication	Overloaded. Sends an asynchronous request to a server, gets information (with file authentication) about images, which are stored in file on server, clears the web document viewer and adds images to the web document viewer.
	registerVisualTool	Registers the visual tool type.
	removePage	Removes the specified page from image collection.
	removePages	Removes the specified pages from image collection.
	saveChanges	Overloaded. Saves changes in a file that was previously opened using the WebDocumentViewerBaseJS.openFile or WebDocumentViewerBaseJS.openFileWithAuthentication function.
	saveChangesAndDownloadFile	Overloaded. Saves changes in a file, which was previously opened using the WebDocumentViewerBaseJS.openFile or WebDocumentViewerBaseJS.openFileWithAuthentication function, and downloads the file.
	set_CurrentUser	Sets the current user.
	set_CurrentVisualTool	Sets the current visual tool of the document viewer. Combination of "current visual tool" and "mandatory visual tool" is used as current visual tool in image viewer.
	set_DocumentLayoutSettings	Sets a document layout settings.
	set_MandatoryVisualTool	Sets the mandatory visual tool of the document viewer. Combination of "current visual tool" and "mandatory visual tool" is used as current visual tool in image viewer.
	setSizeMode	Sets a value indicating how an image is positioned within the viewer.
	setZoom	Sets the image zoom in the viewer.
	startAsyncOperation	Overloaded. Fires "asyncOperationStarted" event. (Inherited from WebUiControlJS)
	swapPages	Swaps the specified pages in source document.
	unregisterVisualTool	Unregisters the visual tool type.

Events

	Name	Description
	asyncOperationFailed	Occurs when asynchronous operation is failed. (Inherited from WebUiControlJS)
	asyncOperationFinished	Occurs when asynchronous operation is finished. (Inherited from WebUiControlJS)
	asyncOperationStarted	Occurs when asynchronous operation is started. (Inherited from WebUiControlJS)
	dialogShown	Occurs when dialog is shown. (Inherited from WebUiControlJS)
	fileOpened	Occurs when file is opened in document viewer.
	thumbnailsDeleted	Occurs when the thumbnails deleted.
	thumbnailsDeleting	Occurs when the thumbnails start deleting.
	warningOccured	Occurs when warning (non-critical error) occurs during the spreadsheet document editor work. (Inherited from WebUiControlJS)

Reference

WebDocumentViewerBaseJS Class
Vintasoft.Imaging.UI Namespace

Send Feedback