addFile(Vintasoft.Shared.WebFileInfoJS,function) Method

In This Topic

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.

Syntax

Javascript (Usage)
Javascript (Specification)

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

var value; // Type: any

// Parameters
var fileId; // Type: WebFileInfoJS
var successFunc; // Type: function

value = instance.addFile(fileId, successFunc);

function addFile(
   fileIdAn instance of WebFileInfoJS class.
 : WebFileInfoJS, 
   successFuncFunction that will be executed if request is executed successfully.
 Here is function prototype "function __success(data)".
 The data parameter has the following properties:
  imageInfos (object): Information about images in image file.
 isAuthenticationRequired (boolean): A value indicating whether current image file requres authentication.
 images (object): An array of WebImageJS objects created using imageInfos property.
 
 : Function
) : any;

Parameters

fileId

An instance of WebFileInfoJS class.

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:

imageInfos (object): Information about images in image file.
isAuthenticationRequired (boolean): A value indicating whether current image file requres authentication.
images (object): An array of WebImageJS objects created using imageInfos property.

Exceptions

Exception	Description
	Thrown if argument has wrong type.

Browser Compatibility

56+

45+

Reference

WebDocumentViewerBaseJS Class
WebDocumentViewerBaseJS Members

Send Feedback