convertFileTo(object,function,function) Метод
В этом разделе
Отправляет асинхронный запрос на преобразование указанного файла изображения.
Синтаксис
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(
: object,
: Function,
: Function
) : WebRequestJS;
Parameters
- convertParams
- Настройки для рендеринга тайлов изображения.
Объект с следующими свойствами:
- fileId (string): Идентификатор файла. Обязательный параметр.
- encoderSettings (object): Экземпляр класса WebImageEncoderSettingsJS, который определяет настройки энкодера. Обязательный параметр.
- пароль (string): Пароль к файлу. Необязательный параметр, значение по умолчанию - null.
- renderingSettings (object): Объект WebRenderingSettingsJS. Необязательный параметр, значение по умолчанию - null.
- successFunc
- Функция, которая будет выполнена, если запрос будет выполнен успешно.
- errorFunc
- Функция, которая будет выполнена в случае неудачного запроса.
Вот прототип функции "function __error(data)".
Параметр 'data' может быть:
- Объект с следующими свойствами:
- errorMessage (string): Сообщение об ошибке.
- blocked (boolean): Указывает, что запрошенное действие заблокировано другим запросом.
, если исключение перехватывается внутри веб сервиса. - В противном случае - объект jqXHR.
Return Value
Объект запроса.
Исключения
Исключение | Описание |
| Выбрасывается, если аргументы имеют неверные типы. |
| Выбрасывается, если конвертер файлов изображений уже имеет активный процесс преобразования файлов изображений ИЛИ конвертер уже отправил запрос. |
Ремарки
Перед вызовом этого метода необходимо вызвать методы "get_IsStarted" и "get_IsActive", чтобы определить, что конвертер не имеет активной конвертации и запрос не был отправлен.
Совместимость с веб браузерами
Смотрите также