VintaSoft Imaging .NET SDK 14.0: Документация для Веб разработчика
Vintasoft.Imaging Namespace / WebImageConverterJS type / convertFileTo Methods / convertFileTo(object) Property
Syntax Exceptions Remarks BrowserCompatibility SeeAlso
В этом разделе
    convertFileTo(object) Метод
    В этом разделе
    Sends an asynchronous request for converting the specified image file.
    Синтаксис
    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
    Настройки для рендеринга тайлов изображения.
    Объект с следующими свойствами:
    • fileId (string): Идентификатор файла. Обязательный параметр.
    • encoderSettings (object): Экземпляр класса WebImageEncoderSettingsJS, который определяет настройки энкодера. Обязательный параметр.
    • пароль (string): Пароль к файлу. Необязательный параметр, значение по умолчанию - null.
    • renderingSettings (object): Объект WebRenderingSettingsJS. Необязательный параметр, значение по умолчанию - null.
    : object
    ) : WebRequestJS;

    Parameters

    convertParams
    Настройки для рендеринга тайлов изображения.
    Объект с следующими свойствами:
    • fileId (string): Идентификатор файла. Обязательный параметр.
    • encoderSettings (object): Экземпляр класса WebImageEncoderSettingsJS, который определяет настройки энкодера. Обязательный параметр.
    • пароль (string): Пароль к файлу. Необязательный параметр, значение по умолчанию - null.
    • renderingSettings (object): Объект WebRenderingSettingsJS. Необязательный параметр, значение по умолчанию - null.

    Return Value

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

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

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