VintaSoft Imaging .NET SDK 14.0: Documentation for Web developer
Vintasoft.Imaging Namespace / WebImageConverterJS type / convertFileTo Methods / convertFileTo(object) Property
Syntax Exceptions Remarks BrowserCompatibility SeeAlso
In This Topic
    convertFileTo(object) Method
    In This Topic
    Sends an asynchronous request for converting the specified image file.
    Syntax
    var instance = new Vintasoft.Imaging.WebImageConverterJS(updateTimeout, service);
    
    var value; // Type: Vintasoft.Shared.WebRequestJS
    
    // Parameters
    var convertParams; // Type: object
    
    value = instance.convertFileTo(convertParams);
    
    
    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
    ) : 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.

    Return Value

    Request object.
    Exceptions
    ExceptionDescription
    Thrown if arguments have wrong types.
    Thrown if image file converter already has active image file converting process OR converter already sent the request.
    Remarks

    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.

    Browser Compatibility
    56+
    45+
    11
    See Also