| Name | Description | |
|---|---|---|
 | WebPdfDocumentEditorControlJS | Initializes a new instance of the WebPdfDocumentEditorControlJS class. |
WebPdfDocumentEditorControlJS Class Members
In This Topic
The following tables list the members exposed by WebPdfDocumentEditorControlJS.
Public Constructors
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. (Inherited from WebDocumentViewerBaseJS) |
| 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. (Inherited from WebDocumentViewerBaseJS) |
| authenticateFile | Overloaded. Sends an asynchronous request to authenticate a file with password. (Inherited from WebDocumentViewerBaseJS) |
| clearCurrentVisualTool | Clears the current visual tool of the document viewer. (Inherited from WebDocumentViewerBaseJS) |
| clearSessionCache | Clears cache for current HTTP session. (Inherited from WebDocumentViewerBaseJS) |
| downloadFile | Overloaded. Downloads a file from server. (Inherited from WebDocumentViewerBaseJS) |
| exportAndDownloadFile | Overloaded. Exports images (with annotations), which are loaded in web image viewer, to a file and downloads the file. (Inherited from WebDocumentViewerBaseJS) |
| exportFile | Overloaded. Exports images (with annotations), which are loaded in web image viewer, to a file. (Inherited from WebDocumentViewerBaseJS) |
| 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. (Inherited from WebDocumentViewerBaseJS) |
| get_ContainerId | Gets an identifier of DOM-element that contains this control. (Inherited from WebUiControlJS) |
| get_CurrentUser | Gets the current user. (Inherited from WebDocumentViewerBaseJS) |
| 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. (Inherited from WebDocumentViewerBaseJS) |
| get_DocumentLayoutSettings | Gets a document layout settings. (Inherited from WebDocumentViewerBaseJS) |
| get_ImageViewer | Gets an image viewer, which is associated with this document viewer. (Inherited from WebDocumentViewerBaseJS) |
| 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. (Inherited from WebDocumentViewerBaseJS) |
| get_OpenedFileId | Gets an identifier of file that was previously opened using the WebDocumentViewerBaseJS.openFile or WebDocumentViewerBaseJS.openFileWithAuthentication function. (Inherited from WebDocumentViewerBaseJS) |
| get_OpenedPdfDocuments | Gets opened PDF documents. |
| get_ThumbnailViewer | Gets a thumbnail viewer, which is associated with this document viewer. (Inherited from WebDocumentViewerBaseJS) |
| getAllRegisteredVisualToolIds | Returns all identifiers of registered visual tools. (Inherited from WebDocumentViewerBaseJS) |
| getAllStandardRegisteredVisualToolIds | Returns identifiers of "standard" registered WebVisualToolJS. (Inherited from WebDocumentViewerBaseJS) |
| getFocusedIndex | Returns the index of focused image. (Inherited from WebDocumentViewerBaseJS) |
| getImages | Returns an image collection, which is associated with the document viewer. (Inherited from WebDocumentViewerBaseJS) |
| getNestedElements | Returns array of nested UI elements. (Inherited from WebUiControlJS) |
| getVisualToolById | Returns visual tool by ID of the visual tool type. (Inherited from WebDocumentViewerBaseJS) |
| gotoNextPage | Navigates an image viewer to the next image. (Inherited from WebDocumentViewerBaseJS) |
| gotoPage | Navigates an image viewer to the specified image. (Inherited from WebDocumentViewerBaseJS) |
| gotoPreviousPage | Navigates an image viewer to the previous image. (Inherited from WebDocumentViewerBaseJS) |
| 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. (Inherited from WebDocumentViewerBaseJS) |
| 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. (Inherited from WebDocumentViewerBaseJS) |
| registerVisualTool | Registers the visual tool type. (Inherited from WebDocumentViewerBaseJS) |
| removePage | Removes the specified page from image collection. (Inherited from WebDocumentViewerBaseJS) |
| removePages | Removes the specified pages from image collection. (Inherited from WebDocumentViewerBaseJS) |
| 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. (Inherited from WebDocumentViewerBaseJS) |
| set_CurrentUser | Sets the current user. (Inherited from WebDocumentViewerBaseJS) |
| 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. (Inherited from WebDocumentViewerBaseJS) |
| set_DocumentLayoutSettings | Sets a document layout settings. (Inherited from WebDocumentViewerBaseJS) |
| 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. (Inherited from WebDocumentViewerBaseJS) |
| setSizeMode | Sets a value indicating how an image is positioned within the viewer. (Inherited from WebDocumentViewerBaseJS) |
| setZoom | Sets the image zoom in the viewer. (Inherited from WebDocumentViewerBaseJS) |
| startAsyncOperation | Overloaded. Fires "asyncOperationStarted" event. (Inherited from WebUiControlJS) |
| swapPages | Swaps the specified pages in source document. (Inherited from WebDocumentViewerBaseJS) |
| unregisterVisualTool | Unregisters the visual tool type. (Inherited from WebDocumentViewerBaseJS) |
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. (Inherited from WebDocumentViewerBaseJS) |
| imageDataReceived | Occurs when data of content image of PDF page is received. |
| thumbnailsDeleted | Occurs when the thumbnails deleted. (Inherited from WebDocumentViewerBaseJS) |
| thumbnailsDeleting | Occurs when the thumbnails start deleting. (Inherited from WebDocumentViewerBaseJS) |
| warningOccured | Occurs when warning (non-critical error) occurs during the spreadsheet document editor work. (Inherited from WebUiControlJS) |
See Also