VintaSoft Twain .NET SDK 15.4: Documentation for Web developer
Vintasoft.Shared Namespace / WebImageCollectionJS type / addFile Methods / addFile(Vintasoft.Shared.WebFileInfoJS,function) Property
Syntax Exceptions BrowserCompatibility SeeAlso
In This Topic
addFile(Vintasoft.Shared.WebFileInfoJS,function) Method
In This Topic
Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property.
Syntax
var instance = new Vintasoft.Shared.WebImageCollectionJS();

var value; // Type: any

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

value = instance.addFile(fileId, successFunc);

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
ExceptionDescription
Thrown if arguments have wrong types.
Browser Compatibility
9
See Also