saveChanges(function,function) Method

In This Topic

Saves changes in a file that was previously opened using the WebDocumentViewerBaseJS.openFile or WebDocumentViewerBaseJS.openFileWithAuthentication function.

Syntax

var instance = new Vintasoft.Imaging.UI.WebDocumentViewerBaseJS(settings);

var value; // Type: any

// Parameters
var successFunc; // Type: function
var errorFunc; // Type: function

value = instance.saveChanges(successFunc, errorFunc);

function saveChanges(
   successFuncFunction that will be executed if request is executed successfully.
 Here is function prototype "function __success(data)".
 The data parameter has the following properties:
  fileId (string): A file identifier.
 
 : Function, 
   errorFuncFunction that will be executed if request is failed.
 Here is function prototype "function __error(data)".
 The data parameter can be:
  An object with following properties:
  errorMessage (string): Error message.
 blocked (boolean): Indicates that the requested action is blocked by another request.
 
 if exception is catched inside web service. 
 Otherwise, jqXHR object.
 
 : Function
) : any;

Parameters

successFunc

Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:

fileId (string): A file identifier.

errorFunc

Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:

An object with following properties:
- errorMessage (string): Error message.
- blocked (boolean): Indicates that the requested action is blocked by another request.
if exception is catched inside web service.
Otherwise, jqXHR object.

Exceptions

Exception	Description
	Thrown if argument has wrong type.
	Thrown if the web document viewer does not have opened file.

Remarks

This function saves the following changes: changes (add, remove, swap) in collection of images/pages, changes in annotations, changes in PDF interactive form.

Example

JavaScript

ThisJavaScriptcodeshowshowtosavechangesinafile,whichisopenedinwebdocumentviewer:
                  // save changes in a file
                  docViewer1.saveChanges(
                      function(data) {
                          console.log("File changes are saved successfully.");
                      },
                      function(data) {
                          console.log("File changes are not saved.");
                      }
                  );

Browser Compatibility

56+

45+

Reference

WebDocumentViewerBaseJS Class
WebDocumentViewerBaseJS Members

Send Feedback