Список версий МТ

Главная

api.interactive

Взаимодействие с пользователем:

//Пример работы api.interactive.selectDate
function selectDate() {
    var ret = api.interactive.selectDate();
    if (ret.success) {
        api.log.debug("Selected: " + ret.value);
    } else {
        api.log.debug("Clicked cancel");
    }
}
//Пример работы api.interactive.inputText
function inputText() {
    var ret = api.interactive.inputText();
    if (retval.success) {
       api.interactive.info("Вы ввели:" + ret.value);
    } else {
        api.interactive.error("cansel");
      }
}

Methods

api.interactive.error(text)
api.interactive.info(text)
api.interactive.inputInt(title, defVal, min, max) → SelectResult
api.interactive.inputReal(title, defVal, min, max, decimals) → SelectResult
api.interactive.inputString(title, defVal, mask, regexp, max) → SelectResult
api.interactive.inputText(title, defVal, max) → SelectResult
api.interactive.msgbox(title, text, format)
api.interactive.question(title, text, buttons, defbutton) → Button
api.interactive.selectDate(title, defVal) → SelectResult
api.interactive.selectDatePeriod(title, defVal) → SelectResult
api.interactive.selectDateTime(title, defVal) → SelectResult
api.interactive.selectMultiItem(title, model, defVal) → SelectResult
api.interactive.selectMultiValue(title, model, defVal) → SelectResult
api.interactive.selectSingleItem(title, model, defVal) → SelectResult
api.interactive.selectSingleValue(title, model, defVal) → SelectResult
api.interactive.selectTime(title, defVal) → SelectResult
api.interactive.selectTimePeriod(title, defVal) → SelectResult
api.interactive.warning(text)

Members

readonly Button :String

Кнопки в диалогах

Properties:
Name Type Default Description
Yes String

Да
No String

Нет
Ok String

Ок
Cancel String

Отмена
Save String

Сохранить
Continue String

Продолжить
Abort String

Прервать
Retry String

Повторить
Ignore String

Пропустить
Close String

Закрыть
Apply String

Применить

Methods description

error(text)

Показать ошибку

Parameters:
Name Type Description
text String

Текст

info(text)

Показать информацию

Parameters:
Name Type Description
text String

Текст

inputInt(title, defVal, min, max) → SelectResult

Ввод числа

Parameters:
Name Type Argument Description
title String

Заголовок
defVal String optional 

Значение по умолчанию
min Number optional 

Минимальное допустимое значение
max Number optional 

Максимально допустимое значение
Return:
SelectResult -

Результат выбора, value содержит введённое число

inputReal(title, defVal, min, max, decimals) → SelectResult

Ввод вещественного числа

Parameters:
Name Type Argument Description
title String

Заголовок
defVal String optional 

Значение по умолчанию
min Number optional 

Минимальное допустимое значение
max Number optional 

Максимально допустимое значение
decimals Number optional 

Число дисятичных знаков
Return:
SelectResult -

Результат выбора, value содержит введённое число

inputString(title, defVal, mask, regexp, max) → SelectResult

Ввод строки

Parameters:
Name Type Argument Description
title String

Заголовок
defVal String optional 

Значение по умолчанию
mask String optional 

Маска ввода
regexp String optional 

Регулярные выражения
max Number optional 

Максимальное колво знаков, если не задано, то без ограничения
Return:
SelectResult -

Результат выбора, value содержит введённую строку

inputText(title, defVal, max) → SelectResult

Ввод текста

Parameters:
Name Type Argument Description
title String

Заголовок
defVal String optional 

Значение по умолчанию
max Number optional 

Максимальное колво знаков, если не задано, то без ограничения
Return:
SelectResult -

Результат выбора, value содержит введённый текст

msgbox(title, text, format)

Окно с сообщением и кнопкой OK (как alert в JS)

Parameters:
Name Type Argument Default Description
title String optional  Сообщение

Заголовок
text String

Текст сообщения
format String optional  plaintext

Формат текста: 'plaintext' или 'richtext' (HTML)

question(title, text, buttons, defbutton) → Button

Задать вопрос

Parameters:
Name Type Description
title String

Заголовок
text String

Текст вопроса
buttons Button

Кнопки, если несколько, то в формате Button1|Button2
defbutton Button

Кнопка по умолчанию
Return:
Button -

Нажатая кнопка

selectDate(title, defVal) → SelectResult

Выбор даты

Parameters:
Name Type Description
title String

Заголовок
defVal Date

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит выбранную дату {Date}

selectDatePeriod(title, defVal) → SelectResult

Выбор периода дат

Parameters:
Name Type Argument Description
title String

Заголовок
defVal Date optional 

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит выбранное время {Date}

selectDateTime(title, defVal) → SelectResult

Выбор даты и времени

Parameters:
Name Type Argument Description
title String

Заголовок
defVal Date optional 

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит выбранную дату и время {Date}

selectMultiItem(title, model, defVal) → SelectResult

Выбор нескольких элементов из списка

Parameters:
Name Type Argument Description
title String

Заголовок
model Array.<Object>

Модель выбора
defVal * optional 

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит список выбранных элементов

selectMultiValue(title, model, defVal) → SelectResult

Выбор нескольких значений из списка

Parameters:
Name Type Argument Description
title String

Заголовок
model Array.<Object>

Модель выбора
defVal * optional 

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит список выбранных значений

selectSingleItem(title, model, defVal) → SelectResult

Выбор одного элемента из списка

Parameters:
Name Type Argument Description
title String

Заголовок
model Array.<Object>

Модель выбора
defVal * optional 

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит выбранный элемент

selectSingleValue(title, model, defVal) → SelectResult

Выбор одного значения из списка

Parameters:
Name Type Argument Description
title String

Заголовок
model Array.<Object>

Модель выбора
defVal * optional 

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит выбранное значение

selectTime(title, defVal) → SelectResult

Выбор времени

Parameters:
Name Type Argument Description
title String

Заголовок
defVal Date optional 

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит выбранное время {Date}

selectTimePeriod(title, defVal) → SelectResult

Выбор периода времени

Parameters:
Name Type Argument Description
title String

Заголовок
defVal Date optional 

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит выбранное время {Date}

warning(text)

Показать предупреждение

Parameters:
Name Type Description
text String

Текст