var instance = new Vintasoft.Imaging.WebImageConverterJS(updateTimeout, service);

var value; // Type: Vintasoft.Shared.WebRequestJS

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

value = instance.convertFileTo(convertParams, successFunc, errorFunc);

function convertFileTo(
   convertParams
Settings for rendering of image tile.
 An object with following properties:
 
 
fileId (string): A file identifier. Required parameter.
 
encoderSettings (object): An instance of WebImageEncoderSettingsJS class that defines the encoder settings. Required parameter.
 
password (string): A file password. Optional parameter, default value is null.
 
renderingSettings (object): WebRenderingSettingsJS object. Optional parameter, default value is null.
 
 : object, 
   successFunc
Function that will be executed if request is executed successfully.
 : Function, 
   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.
 
 : Function
) : WebRequestJS;

Parameters

convertParams

Settings for rendering of image tile.
An object with following properties:

• fileId (string): A file identifier. Required parameter.
• encoderSettings (object): An instance of WebImageEncoderSettingsJS class that defines the encoder settings. Required parameter.
• password (string): A file password. Optional parameter, default value is null.
• renderingSettings (object): WebRenderingSettingsJS object. Optional parameter, default value is null.

successFunc

Function that will be executed if request is executed successfully.

errorFunc

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

1. 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.
2. Otherwise, jqXHR object.

Return Value

Before calling this method you must call the "get_IsStarted" and "get_IsActive" to determine that converter does not have active convertation and the request was not sent.

Reference

WebImageConverterJS Class
WebImageConverterJS Members