Инструменты · Формы
form_read
Читает управляемую форму по адресу — дерево элементов с путями к данным и командами кнопок, свойства формы или её узла, срезы реквизитов, команд и параметров. Грань #help — контракт form_write для адреса, #screenshot — картинка формы, как её рисует EDT.
Когда использовать
- Перед добавлением поля — дерево формы: группы, соседние поля, пути к данным.
- Проверить свойства элемента или реквизита формы;
detail: brief— только настроенное. - Какие команды можно повесить на кнопку — срез
<форма>.Command: команды формы, объекта-владельца и стандартные. - Посмотреть результат правок глазами человека —
#screenshot.
Соседние инструменты домена «Формы»
Операции
Параметра operation у инструмента нет: что вернуть, задаёт адрес fqn — маркер-хвост и грань после #.
| Адрес или грань | Что возвращает |
|---|---|
<форма> | Дерево формы: элементы, реквизиты и параметры; основной реквизит отмечен 🔑, тип данных — в квадратных скобках, у полей — путь к данным, у кнопок — команда |
<форма>#properties | Свойства формы; синоним #свойства |
<форма>.Item.<Имя> | Свойства элемента |
<форма>.Item.<Имя>#source | Поддерево элемента-группы |
<форма>.Attribute.<Имя>, .Command.<Имя>, .Parameter.<Имя> | Свойства реквизита, команды, параметра формы |
<форма>.Item, .Attribute, .Command, .Parameter | Срез коллекции списком; .Command добавляет стандартные команды @… и команды объекта-владельца |
<форма>.Item.<Таблица>.Command | Команды таблицы формы |
<адрес>#help | Контракт definition для form_write по адресу; работает и для несуществующего компонента |
<форма>#screenshot | Картинка формы, как в редакторе EDT |
Параметры
| Параметр и тип | Обязательный | Описание | По умолчанию |
|---|---|---|---|
projectстрока | да | Идентификатор проекта рабочей области EDT — имя из ответа project_read (например, УТ2020). Для расширения — проект расширения. | — |
fqnстрока | да | Адрес формы <Тип>.X.Form.Y или CommonForm.X с хвостом компонента и гранью #. Маркеры — по-русски или по-английски: Элемент, Реквизит, Команда, Параметр. | — |
detailстрока | нет | Только для свойств: brief — значения, отличные от умолчания, и число скрытых; default — все значения, идентификатор, расширенные свойства и события; full — плюс тип каждого свойства.значения: brief · default · full | default |
filterстрока | нет | Регулярное выражение без учёта регистра по именам: у структуры сужает дерево и списки, у свойств — отбирает свойства и события. | — |
refreshбулево | нет | Только для #screenshot: перестроить представление формы перед снимком. | false |
limitцелое | нет | Окно чтения: сколько строк готового ответа вернуть. По умолчанию 200, максимум 1000. | 200 |
offsetцелое | нет | Окно чтения: номер строки ответа, с которой начать (0 — первая страница). Значение для следующей страницы подсказывает строка *lines: …* в конце ответа. | 0 |
Таблица собрана из схемы инструмента, которую получает агент при подключении.
Адреса
Адреса форм — только здесь: metadata_read формы не читает.
| Адрес | Что адресует |
|---|---|
Catalog.Контрагенты.Form.ФормаЭлемента | дерево формы |
Catalog.Контрагенты.Form.ФормаЭлемента#properties | свойства формы |
Catalog.Контрагенты.Form.ФормаЭлемента.Item.Наименование | свойства элемента |
Catalog.Контрагенты.Form.ФормаЭлемента.Attribute | реквизиты формы деревом |
Catalog.Контрагенты.Form.ФормаЭлемента.Command | команды формы, владельца и стандартные |
Catalog.Контрагенты.Form.ФормаЭлемента.Item#help | контракт пачки элементов |
Catalog.Контрагенты.Form.ФормаЭлемента#screenshot | снимок формы |
Пример вызова и ответа
{ "project": "УТ2020", "fqn": "Catalog.Контрагенты.Form.ФормаЭлемента.Attribute", "detail": "brief" }Пример ответа в подготовке Устройство ответа — на странице Формат ответов.
Отказы и ошибки
Адрес не формы
Адрес без сегмента Form — ошибка параметров: объекты читает metadata_read.
Компонент не найден
Имени нет на форме — ответ предлагает ближайшие имена.
failed · лицензия
Без действующего ключа инструмент отвечает карточкой failed с сообщением лицензия: … и подсказкой, где ввести ключ; в секции Context — список инструментов, доступных без ключа. Подробнее — Лицензия и бесплатный доступ.
Ограничения
- Снимок формы строит редактор EDT; для только что изменённой формы при расхождении используйте
refresh: true.