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

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

// Parameters
var converterParams; // Type: object
var successFunc; // Type: function

value = instance.convertFileTo(converterParams, successFunc);

function convertFileTo(
   converterParams
Settings for converting of image/document file.
 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.
 
pageSize (object): The page size settings.
 
createFileInCacheFolder (boolean): A value indicating whether converter file must be created in cache folder. True - converter file must be created in cache folder (by default folder "VintasoftCache/{SessionId}/ConvertedFiles/"); False - converted file must be created in folder with source file (by default folder "UploadedImageFiles/{SessionId}/"). Default value is True.
 
 : object, 
   successFunc
Function that will be executed if request is executed successfully.
 : Function
) : WebRequestJS;

Parameters

converterParams

Settings for converting of image/document file.
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.
• pageSize (object): The page size settings.
• createFileInCacheFolder (boolean): A value indicating whether converter file must be created in cache folder. True - converter file must be created in cache folder (by default folder "VintasoftCache/{SessionId}/ConvertedFiles/"); False - converted file must be created in folder with source file (by default folder "UploadedImageFiles/{SessionId}/"). Default value is True.

successFunc

Function that will be executed if request is executed successfully.

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

WebFileConverterJS Class
WebFileConverterJS Members