VintaSoft Imaging .NET SDK 15.0: Документация для Веб разработчика
Vintasoft.Imaging Namespace / WebFileConverterJS type / convertFileTo Methods / convertFileTo(object,function,function) Property
Syntax Exceptions Remarks BrowserCompatibility SeeAlso
В этом разделе
    convertFileTo(object,function,function) Метод
    В этом разделе
    Отправляет асинхронный запрос на преобразование указанного файла изображения/документа.
    Синтаксис
    var instance = new Vintasoft.Imaging.WebFileConverterJS(updateTimeout, service);
    
    var value; // Type: Vintasoft.Shared.WebRequestJS
    
    // Parameters
    var converterParams; // Type: object
    var successFunc; // Type: function
    var errorFunc; // Type: function
    
    value = instance.convertFileTo(converterParams, successFunc, errorFunc);
    
    
    function convertFileTo(
    converterParams
    Настройки для преобразования файла изображения/документа.
    Объект со следующими свойствами:
    • fileId (string): Идентификатор файла. Обязательный параметр.
    • encoderSettings (object): Экземпляр класса WebImageEncoderSettingsJS, определяющий настройки энкодера. Обязательный параметр.
    • password (string): Пароль к файлу. Необязательный параметр, значение по умолчанию - null.
    • renderingSettings (object): Объект WebRenderingSettingsJS. Необязательный параметр, значение по умолчанию - null.
    • pageSize (object): Настройки размера страницы.
    • createFileInCacheFolder (boolean): Значение, указывающее, должен ли конвертированный файл быть создан в папке кэша. True - конвертированный файл должен быть создан в папке кэша (по умолчанию папка "VintasoftCache/{SessionId}/ConvertedFiles/"); False - конвертированный файл должен быть создан в папке с исходным файлом (по умолчанию папка "UploadedImageFiles/{SessionId}/"). Значение по умолчанию - True.
    : object,
    successFunc
    Функция, которая будет выполнена, если запрос будет выполнен успешно.
    : Function,
    errorFunc
    Функция, которая будет выполнена в случае неудачного запроса.
    Вот прототип функции "function __error(data)".
    Параметр 'data' может быть:
    1. Объект с следующими свойствами:
      • errorMessage (string): Сообщение об ошибке.
      • blocked (boolean): Указывает, что запрошенное действие заблокировано другим запросом.
      , если исключение перехватывается внутри веб сервиса.
    2. В противном случае - объект jqXHR.
    : Function
    ) : WebRequestJS;

    Parameters

    converterParams
    Настройки для преобразования файла изображения/документа.
    Объект со следующими свойствами:
    • fileId (string): Идентификатор файла. Обязательный параметр.
    • encoderSettings (object): Экземпляр класса WebImageEncoderSettingsJS, определяющий настройки энкодера. Обязательный параметр.
    • password (string): Пароль к файлу. Необязательный параметр, значение по умолчанию - null.
    • renderingSettings (object): Объект WebRenderingSettingsJS. Необязательный параметр, значение по умолчанию - null.
    • pageSize (object): Настройки размера страницы.
    • createFileInCacheFolder (boolean): Значение, указывающее, должен ли конвертированный файл быть создан в папке кэша. True - конвертированный файл должен быть создан в папке кэша (по умолчанию папка "VintasoftCache/{SessionId}/ConvertedFiles/"); False - конвертированный файл должен быть создан в папке с исходным файлом (по умолчанию папка "UploadedImageFiles/{SessionId}/"). Значение по умолчанию - True.
    successFunc
    Функция, которая будет выполнена, если запрос будет выполнен успешно.
    errorFunc
    Функция, которая будет выполнена в случае неудачного запроса.
    Вот прототип функции "function __error(data)".
    Параметр 'data' может быть:
    1. Объект с следующими свойствами:
      • errorMessage (string): Сообщение об ошибке.
      • blocked (boolean): Указывает, что запрошенное действие заблокировано другим запросом.
      , если исключение перехватывается внутри веб сервиса.
    2. В противном случае - объект jqXHR.

    Return Value

    Объект запроса.
    Исключения
    ИсключениеОписание
    Выбрасывается, если аргументы имеют неверные типы.
    Выбрасывается, если конвертер файлов изображений уже имеет активный процесс преобразования файлов изображений ИЛИ конвертер уже отправил запрос.
    Ремарки

    Перед вызовом этого метода необходимо вызвать методы "get_IsStarted" и "get_IsActive", чтобы определить, что конвертер не имеет активной конвертации и запрос не был отправлен.

    Совместимость с веб браузерами
    9
    5
    11
    5
    Смотрите также