Свойства компонента интерфейса, унаследованного от компонента «ФормаСписка»

Форма списка предназначена для работы со списками экземпляров сущностей.

При открытии формы в модальном или всплывающем окне возвращает значение типа ТипРезультата. По умолчанию — Неопределено. Если закрыть форму нажатием на крестик или кликом мимо окна при открытии во всплывающем окне или вызвать метод Закрыть без передачи аргумента, результатом открытия будет Неопределено.

Иерархия наследования

Компонент (абстрактный)
- ПроизвольныйКомпонент
  - Форма<ТипРезультата>
    - ФормаСписка<ТипРезультата>

Свойства

КомпонентТаблицы

Внутренний компонент формы, унаследованный от Таблица, который является основной таблицей. Например:

КомпонентТаблицы: =Компоненты.Cписок.Компоненты.Таблица

Обновить

Команда. Принудительно обновить данные в форме

Создать

Команда. Создать новый элемент списка

ВключатьВАвтоИнтерфейс

Признак того, что включит команду открытия этой формы в автоматический интерфейс. Стандартное значение Ложь.

ДополнительныеКоманды

Экземпляр ФрагментКомандногоИнтерфейса<ТипКоманды>, состоящий из команд. Список дополнительных команд формы. Отображаются в правой части заголовка формы (веб-интерфейс) или под заголовком формы (мобильный интерфейс).

Заголовок

Заголовок формы

ЗаголовокКомандыСоздания

Заголовок кнопки создания на форме списка. Если заголовок задан, то в веб-интерфейсе кнопка отображается в заголовке формы, а в мобильном интерфейсе отображается плавающая кнопка

Закрыть

Команда. Команда закрытия формы

Изображение

Задает картинку для автогенерируемой навигационной команды <ИмяФормы>.ОткрытьФорму.

КомандыСоздания

Экземпляр ОбычнаяКоманда либо экземпляр ГруппаКомандногоИнтерфейса<ТипКоманды>, состоящая из обычных команд. Задает команду или группу команд кнопке создания. Место и вид отображения кнопки создания может быть различным в зависимости от вида интерфейса:

В мобильном интерфейсе это плавающая кнопка, которая отображается в правом нижнем углу экрана;
В веб-интерфейсе кнопка отображается справа от заголовка формы

Пример команды создания Добавить сотрудника в веб-интерфейсе:

ОбычныеКоманды

Экземпляр ФрагментКомандногоИнтерфейса<ТипКоманды>, состоящий из команд. Список основных команд формы. Отображаются в нижней панели команд формы в виде обычных кнопок. Обычные команды отображаются после основной команды.

ОсновнаяКоманда

ОбычнаяКоманда. Задает команду, которая определяет главное действие формы. Здесь мы рекомендуем использовать команду, после вызова которой форма будет закрыта. Типичные примеры:

Сохранить (и закрыть)
Отправить (письмо)
Закрыть

Отображается в нижней панели команд формы. Выглядит как основная кнопка.

ПовторноеИспользованиеФормы

Авто|Булево. Признак повторного использования формы. Возможные значения свойства:

Авто — (по умолчанию) система сама определяет, может ли форма использоваться повторно. Формы списков по возможности используются повторно, остальные формы — нет.
Истина — форма используется повторно. Форма, открытая в основной области, при закрытии не удаляется. При повторном открытии формы открывается тот же самый экземпляр.
Ложь — форма не используется повторно.

ПодсказкиПриПервомОткрытии

ПоследовательностьОбучающихПодсказок. Последовательность подсказок, которая запускается автоматически при первом открытии формы. Если данная последовательность уже была просмотрена пользователем до конца, то больше она запускаться не будет.

Состоит из элементов типа ОбучающаяПодсказка. Обучающая подсказка обладает следующими свойствами:

Заголовок — заголовок подсказки
Описание — текст внутри подсказки
ОпорныйЭлемент — компонент, около которого появляется подсказка.
Изображение — изображение внутри подсказки

Пример:

ВидЭлемента: КомпонентИнтерфейса
Ид: 63ddc157-05cd-4187-8d86-546634e011d6
Имя: СделкиФормаОбъекта
ОбластьВидимости: ВПроекте
Наследует:
    Тип: ФормаОбъекта<Сделки.Объект>
    Заголовок: ПолучитьЗаголовокФормы()
    Содержимое:
        Тип: ПроизвольныйШаблонФормы
        Содержимое:
            Тип: РазделяющаяГруппа
            Содержимое:
                -
                    Заголовок: $ЛокализованныеСтроки.Основное
                    ОтступПоГоризонтали: Одинарный
                    Содержимое:
                        -
                            Тип: КомпонентСЗаголовком
                            Имя: ПолеВводаКлиент
                            Заголовок: $ЛокализованныеСтроки.Клиент
                            ПоложениеЗаголовка: Верх
                        -
                            Тип: ПолеВвода<Сделки.Ссылка?>
                            Имя: ПолеВводаНаправление
                            Заголовок: $ЛокализованныеСтроки.Направление
                            Значение: =Объект.Направление
                            Обязательное: Истина
    ПодсказкиПриПервомОткрытии:
      Тип: ПоследовательностьОбучающихПодсказок
      Элементы:
          -
               Заголовок: Приветствую! 🤝
               Изображение: ОбучающиеПодсказки/Приветствие.png
               Описание: "Позвольте помочь вам создать новую сделку! Сделка отражает процесс 
                          оказания услуги клиенту нашей компании на каждой стадии этого процесса. 
                          Для начала нужно выбрать клиента."
               ОпорныйЭлемент: =Компоненты.ПолеВводаКлиент
          -
              Заголовок: Выбор направления
              Описание: "Сделка может относиться к одному из нескольких направлений, по которым 
                         наша компания предоставляет услуги."
              ОпорныйЭлемент: =Компоненты.ПолеВводаНаправление

По умолчанию последовательность обучающих подсказок запускается при открытии формы и переключается по кнопке Далее. Однако вы также можете управлять их поведением через специальные методы формы: ЗапуститьОбучающиеПодсказки, ОстановитьОбучающиеПодсказки, ПоказатьСледующуюОбучающуюПодсказку. Для этого необходимо описать последовательность обучающих подсказок и вызвать соответствующий метод в модуле формы.

Пример открытия последовательности обучающих подсказок при нажатии на кнопку:

ВидЭлемента: КомпонентИнтерфейса
Ид: 6e1a945d-f5c0-4a54-b4e0-0bd7ef2f3eb0
Имя: ТестПереключенияПодсказок
ОбластьВидимости: ВПодсистеме
Наследует:
    Тип: Форма
    Заголовок: Тест возможных кейсов при переключении подсказок
    Содержимое:
        Тип: ПроизвольныйШаблонФормы
        Содержимое:
            Тип: ФиксированнаяГруппа
            ВыравниваниеСодержимогоПоВертикали: Центр
            Рамка: Истина
            Содержимое:
                -
                    # Описание кнопки, при нажатии на которую будет запускаться 
                    # последовательность обучающих подсказок.
                    Тип: Кнопка
                    Имя: КнопкаЗапускающаяТуториал
                    Заголовок: Запустить туториал на дальнюю страницу
                    Вид: Основная
                    РастягиватьПоГоризонтали: Истина
                    ПриНажатии: СгенерироватьТуториал

// Обработчик кнопки «ПриНажатии». Внутри обработчика осуществляется
// создание и запуск последовательности обучающих подсказок.
метод СгенерироватьТуториал(Источник: Кнопка, Событие: СобытиеПриНажатии)
    пер Последовательность = новый ПоследовательностьОбучающихПодсказок([
        новый ОбучающаяПодсказка(
            ОпорныйЭлемент = Компоненты.ПропадающаяГруппа,
            Заголовок = "Приветствую! 🤝", 
            Описание = 
                       "Позвольте помочь вам создать новую сделку! Сделка отражает процесс 
                        оказания услуги клиенту нашей компании на каждой стадии этого процесса. 
                        Для начала нужно выбрать клиента."
        )
        ])
        
    этот.ЗапуститьОбучающиеПодсказки(Последовательность)
;

ОтступПоВертикали

Вертикальный отступ от границы компонента до его содержимого:

ОтступПоГоризонтали

Горизонтальный отступ от границы компонента до его содержимого:

Содержимое

Экземпляр компонента, расположенный в данном компоненте. Содержит следующие свойства:

Тип

Обязательное. Имя компонента, экземпляр которого вы описываете. Это может быть системный компонент или компонент интерфейса. Пример YAML-файла:

ВидЭлемента: КомпонентИнтерфейса
Ид: 9f51db7f-c98d-499c-9607-545d5e0a58c2
Имя: МояФормаОбъекта
Наследует:
    Тип: ФормаОбъекта<МойСправочник.Объект>
    ВключатьВАвтоИнтерфейс: Ложь
    Содержимое:
        Тип: ПроизвольныйШаблонФормы
        Содержимое:
            Тип: ФиксированнаяГруппа
            Содержимое:
                -
                    Тип: Флажок
                    Имя: ЗагружатьВсе
                    Заголовок: Загружать все данные
                    Значение:
                        Тип: Булево
                        Значение: Истина
                -
                    Тип: Флажок
                    Имя: ПерезаписыватьСтарые
                    Заголовок: Перезаписывать старые элементы

Имя

Имя экземпляра компонента. По этому имени можно будет обратиться к экземпляру. Пример YAML-файла:

ВидЭлемента: КомпонентИнтерфейса
Ид: 9f51db7f-c98d-499c-9607-545d5e0a58c2
Имя: МояФормаОбъекта
Наследует:
    Тип: ФормаОбъекта<МойСправочник.Объект>
    ВключатьВАвтоИнтерфейс: Ложь
    Содержимое:
        Тип: ПроизвольныйШаблонФормы
        Содержимое:
            Тип: ФиксированнаяГруппа
            Имя: Флажки
            Содержимое:
                -
                    Тип: Флажок
                    Имя: ЗагружатьВсе
                    Заголовок: Загружать все данные
                    Значение: Истина
                -
                    Тип: Флажок
                    Имя: ПерезаписыватьСтарые
                    Заголовок: Перезаписывать старые элементы

Например, к его свойству Видимость:

ВидЭлемента: КомпонентИнтерфейса
Ид: 9f51db7f-c98d-499c-9607-545d5e0a58c2
Имя: МояФормаОбъекта
Наследует:
    Тип: ФормаОбъекта<МойСправочник.Объект>
    ВключатьВАвтоИнтерфейс: Ложь
    Видимость: =Компоненты.Флажки.Видимость
    Содержимое:
        Тип: ПроизвольныйШаблонФормы
        Содержимое:
            Тип: ФиксированнаяГруппа
            Имя: Флажки
            Содержимое:
                -
                    Тип: Флажок
                    Имя: ЗагружатьВсе
                    Заголовок: Загружать все данные
                    Значение: Истина
                -
                    Тип: Флажок
                    Имя: ПерезаписыватьСтарые
                    Заголовок: Перезаписывать старые элементы

ОтслеживатьИзменениеДанных

Не обязательное. По умолчанию Ложь.

Если Истина, то будет учитывать изменение данных в этом экземпляре при вычислении свойства РассчитаннаяМодифицированность у экземпляра этого компонента интерфейса. Пример YAML-файла:

ВидЭлемента: КомпонентИнтерфейса
Ид: 9f51db7f-c98d-499c-9607-545d5e0a58c2
Имя: МояФормаОбъекта
Наследует:
    Тип: ФормаОбъекта<МойСправочник.Объект>
    ВключатьВАвтоИнтерфейс: Ложь
    Содержимое:
        Тип: ПроизвольныйШаблонФормы
        Содержимое:
            Тип: ФиксированнаяГруппа
            ОтслеживатьИзменениеДанных: Истина
            Содержимое:
                -
                    Тип: Флажок
                    Имя: ЗагружатьВсе
                    Заголовок: Загружать все данные
                    Значение: Истина
                -
                    Тип: Флажок
                    Имя: ПерезаписыватьСтарые
                    Заголовок: Перезаписывать старые элементы

<Свойство компонента>

Значение свойства компонента в этом экземпляре. Если тип свойства составной (включает несколько типов), необходимо указать тип значения. Иначе просто само значение. Пример YAML-файла:

ВидЭлемента: КомпонентИнтерфейса
Ид: 9f51db7f-c98d-499c-9607-545d5e0a58c2
Имя: МояФормаОбъекта
Наследует:
    Тип: ФормаОбъекта<МойСправочник.Объект>
    ВключатьВАвтоИнтерфейс: Ложь
    Содержимое:
        Тип: ПроизвольныйШаблонФормы
        Содержимое:
            Тип: ФиксированнаяГруппа
            Ориентация: Горизонтальная
            Содержимое:
                -
                    Тип: Флажок
                    Имя: ЗагружатьВсе
                    Заголовок: Загружать все данные
                    Значение:
                        Тип: Булево
                        Значение: Истина
                -
                    Тип: Флажок
                    Имя: ПерезаписыватьСтарые
                    Заголовок: Перезаписывать старые элементы

<Событие компонента>

Имя метода, обрабатывающего событие компонента в этом экземпляре. Метод должен находиться в модуле компонента. Пример YAML-файла:

ВидЭлемента: КомпонентИнтерфейса
Ид: 9f51db7f-c98d-499c-9607-545d5e0a58c2
Имя: МояФормаОбъекта
Наследует:
    Тип: ФормаОбъекта<МойСправочник.Объект>
    ВключатьВАвтоИнтерфейс: Ложь
    Содержимое:
        Тип: ПроизвольныйШаблонФормы
        Содержимое:
            Тип: ФиксированнаяГруппа
            ПриНаведении: ОбработчикПриНаведении
            Содержимое:
                -
                    Тип: Флажок
                    Имя: ЗагружатьВсе
                    Заголовок: Загружать все данные
                    Значение:
                        Тип: Булево
                        Значение: Истина
                -
                    Тип: Флажок
                    Имя: ПерезаписыватьСтарые
                    Заголовок: Перезаписывать старые элементы

События

ПриОбновлении

Переопределяемый обработчик. Выполняется при запуске пользователем обновления данных формы через команду Обновить или с помощью жеста pull-to-refresh в мобильном приложении. Сигнатура обработчика:

@Обработчик
метод ПриОбновлении()
;