Перейти к основному содержимому

Список

Стд::Интерфейс::Списки::Список<ТипИсточника> Доступность: Клиент

ТипИсточника: Тип источника данных списка. Ограничения параметра типа: Стд::Интерфейс::ИсточникиДанных::ИсточникДанных<неизвестно,неизвестно,неизвестно>. Параметр типа должен иметь значение по умолчанию или Неопределено в составе типов.

Базовый тип для компонентов-списков. Компонент-список отображает набор записей данных, например: таблица, список карточек.

Сравнение ссылочное

Иерархия типа​

Базовые типы: Объект, Стд::Интерфейс::Компонент

Дочерние типы: ПроизвольныйСписок, СтандартныйСписок, Таблица

Свойства​

АвтоВыделениеСтроки​

Доступность: Клиент

АвтоВыделениеСтроки: Авто|АвтоВыделениеСтроки

Устанавливает режим автоматической установки текущей строки списка. При значении ВыделятьПервый и ИспользоватьВыделениеСтроки = Истина при первом отображении списка текущей строкой будет автоматически установлена первая строка и будет вызвано соответствующее событие ПриВыделенииСтроки. Событие ПриНажатииСтроки при этом вызвано не будет.

При Авто Определяется автоматически системой.

Восстановить​

Доступность: Клиент ТолькоЧтение

Восстановить: КомандаСПараметром<ТипИсточника.ItemDataType|ТипИсточника.NodesDataType|Массив<ТипИсточника.IdType>>

Встроенная команда восстановления строк, помеченных на удаление. Может входить в состав свойства КомандыСтроки Команда доступна, если источником данных является ДинамическийСписок, у которого РежимУдаления = ПометкаУдаления и строка помечена на удаление.

ВыделеннаяСтрока​

Доступность: Клиент ТолькоЧтение

ВыделеннаяСтрока: ТипИсточника.IdType?

Содержит идентификатор текущей строки списка или Неопределено, если текущей строки нет. Идентификаторы строк списка зависят от типа источника:

  • В случае динамического списка - это ссылка на элемент справочника.
  • В случае источника данных на основе массива - это данные строки. Используется ссылочное сравнение данных элемента, за исключением следующих типов:

ДобавитьСтроку​

Доступность: Клиент ТолькоЧтение

ДобавитьСтроку: Команда|ГруппаКомандногоИнтерфейса

Встроенная команда добавления новой строки.

ЗамещающийТекстПоляПоиска​

Доступность: Клиент

ЗамещающийТекстПоляПоиска: Авто|Строка

Устанавливает в поле ввода поиска подсказку ввода. Если не задано будет отображено "Поиск..."

ИспользованиеПоиска​

Доступность: Клиент

ИспользованиеПоиска: Авто|Булево
  • Истина – строка поиска будет отображена и задействована вне зависимости от наличия данных, по которым можно искать
  • Ложь – строка поиска не будет отображена и задействована
  • Авто – строка поиска будет отображена и задействована при наличии данных по которым можно искать

Поиск осуществляется как по источнику ДинамическийСписок, так и по ИсточникДанныхМассив. Для точечной параметризации поиска по определенным полям следует обратиться к описанию вышеописанных источников.

Поиск по полю составного типа (например, Тип1 | Тип2) осуществляется только если все входящие в состав типы поддерживают поиск.

Особенность поиска для ИсточникДанныхМассив

Для источника типа ИсточникДанныхМассив описание полей для разрешения функции поиска необязательно.

Если элементом массива является:

  • ЧитаемыйМассив - поиск будет осуществлен по всем допустимым для него типам элементов этого массива
  • ЧитаемоеСоответствие - поиск будет осуществлен по всем допустимым для него типам значений этого соответствия
  • КлючИЗначение - поиск будет осуществлен по всем допустимым типам значения
  • Строка - поиск будет осуществлен по всем строкам
  • Сущность.Ссылка - поиск будет осуществлен по всем представлениям ссылок
  • Перечисление - поиск будет осуществлен по всем представлениям перечисления

ИспользоватьВыделениеСтроки​

Доступность: Клиент

ИспользоватьВыделениеСтроки: Авто|Булево

Указывает на возможность использования текущей строки. Если Ложь - функциональность текущей строки не используется, при этом:

ИспользоватьОтметкиСтрок​

Доступность: Клиент

ИспользоватьОтметкиСтрок: Авто|Булево

Включает или выключает функциональность множественного выделения строк таблицы. Если равно Истина, то в таблицу будет автоматически добавлена специальная колонка с флажками для выбора строк.

ИспользоватьРасширенныеНастройки​

Доступность: Клиент

ИспользоватьРасширенныеНастройки: Авто|Булево

Включает расширенный режим настроек таблицы.

Источник​

Доступность: Клиент

Источник: ТипИсточника

Источник данных списка.

Команды​

Доступность: Клиент

Команды: ФрагментКомандногоИнтерфейса?

Команды, которые будут отображены в командной панели списка

КомандыНадОтмеченнымиСтроками​

Доступность: Клиент

КомандыНадОтмеченнымиСтроками: ФрагментКомандногоИнтерфейса<КомандаСПараметром<Массив<ТипИсточника.IdType>>>?

Описание команд действий выпадающей панели над множеством отмеченных строк.

Параметр обработчика команды - массив идентификаторов строк списка. Идентификаторы строк списка зависят от типа источника:

  • В случае динамического списка - это ссылка на элемент справочника.
  • В случае источника данных на основе массива - это данные строки.

Если Авто – команды, описанные в КомандыСтроки, имеющий тип КомандаСПараметром<Массив<ТипИсточника.ТипИдентификатора>> автоматически попадут в КомандыНадОтмеченнымиСтроками

КомандыСтроки​

Доступность: Клиент

КомандыСтроки: ФрагментКомандногоИнтерфейса<КомандаСПараметром<ТипИсточника.ItemDataType>>?

Команды, которые будут доступны для строки.

Параметр обработчика команды - данные строки списка

Идентификатор строки списка зависит от типа источника:

  • В случае динамического списка - это ссылка на элемент справочника.
  • В случае источника данных на основе массива - это данные строки.

КомандыСтрокиГруппы​

Доступность: Клиент

КомандыСтрокиГруппы: ФрагментКомандногоИнтерфейса<КомандаСПараметром<ТипИсточника.NodesDataType>>?

Команды, которые будут доступны для групповой строки.

Параметр обработчика команды - данные групповой строки списка.

Навигация​

Доступность: Клиент

Навигация: Авто|НавигацияВСписке

Задает тип навигации, используемый списком.

Если используется ИсточникДанныхДерево, ИсточникДанныхДеревоПодгружаемый или иерархический ДинамическийСписок - всегда ПодгрузкаПриПрокрутке

НачальныйУровеньРазворачивания​

Доступность: Клиент

НачальныйУровеньРазворачивания: Авто|Число

Устанавливает начальное отображение списка с иерархическим источником данных относительно корня. Если Источник - это ИсточникДанныхДеревоПодгружаемый, раскрывается УзелДереваСДаннымиПодгружаемый и для него инициируется событие ПриЗаполненииДочернихЭлементов.

При значении равным -1 - рекурсивно разворачивает все дочерние узлы. Авто интерпретируется, как 0.

Игнорируется в мобильной версии.

ОбрабатыватьНажатие​

Доступность: Клиент

ОбрабатыватьНажатие: Авто|Булево

Определяет, является элемент нажимаемым или нет. По умолчанию равно Авто, и поведение нажатия определяется системой.

Если Истина, строка будет кликабельной

Если Ложь, строка не будет кликабельной ни при каких условиях

Имеет приоритет над свойством ИспользоватьВыделениеСтроки. Последнее не будет работать, если данное свойство установлено в Ложь.

В списках отключает как возможность нажатия, так и подсветку элемента при наведении на него. В таблицах отключает только возможность нажатия.

ОтметитьВсеВГруппе​

Доступность: Клиент ТолькоЧтение

ОтметитьВсеВГруппе: КомандаСПараметром<ТипИсточника.IdType|ТипИсточника.NodesDataType>

Используется только с иерархическими источниками данных. Команда отметки всех дочерних элементов внутри целевой группы (кроме самой группы). Если в группе отмечены все дочерние - команда работает наоборот.

ОтмечатьГруппыСДочерними​

Доступность: Клиент

ОтмечатьГруппыСДочерними: Авто|Булево

Используется только с иерархическими источниками данных. Если Истина: в случае если строка является групповой - отмечает и снимает отметки, в том числе для дочерних Если Ложь: строки отмечаются по одиночке

Для древовидного источника типа ДинамическийСписок выделение потомков системно не осуществляется.

ОтображатьНастройки​

Доступность: Клиент

ОтображатьНастройки: Авто|Булево

Если установлено в Истина, то у таблицы включается механизм настройки в случае, если Источник - ДинамическийСписок. Механизм настройки включает в себя настройки двух видов: простые и продвинутые. Пользователь сможет переключаться между ними самостоятельно. Изначальный вид зависит от флага ИспользоватьРасширенныеНастройки и состава предопределенных (описанных разработчиком фильтров у источника данных) или сохраненных настроек таблицы.

ОтображатьПанельКомандНадОтмеченнымиСтроками​

Доступность: Клиент

ОтображатьПанельКомандНадОтмеченнымиСтроками: Авто|Булево

Включает или выключает панель команд над отмеченными строками таблицы.

ОтображениеПоляПоиска​

Доступность: Клиент

ОтображениеПоляПоиска: Авто|ВидОтображенияПоляПоискаВСписке

Управляет отображением поисковой строки.

Если Авто:

  • если панель команд доступна – отображает поле поиска в ней
  • если нет – отдельным полем над таблицей или списком.

ПереместитьСтрокуВверх​

Доступность: Клиент ТолькоЧтение

ПереместитьСтрокуВверх: КомандаСПараметром<ТипИсточника.ItemDataType|ТипИсточника.NodesDataType|Массив<ТипИсточника.IdType>>

Встроенная команда перемещения строк вверх.

ПереместитьСтрокуВниз​

Доступность: Клиент ТолькоЧтение

ПереместитьСтрокуВниз: КомандаСПараметром<ТипИсточника.ItemDataType|ТипИсточника.NodesDataType|Массив<ТипИсточника.IdType>>

Встроенная команда перемещения строк вниз.

ПослеСозданияСтроки​

Доступность: Клиент

ПослеСозданияСтроки: (
Список<ТипИсточника>,
СобытиеСДанными<СтрокаСписка<ТипИсточника.ItemDataType|ТипИсточника.NodesDataType>>)->ничто

Вызывается после автоматического создания компонента строки списка системой. Данные события - новая строка списка. Позволяет донастроить созданный компонент или подписаться на его события.

Новая строка списка в данном событии полностью сконструирована:

  • заполнено свойство ДанныеСтроки,
  • по описанию компонента созданы его внутренние компоненты и установлены значения их свойств.

ПредставлениеГрупповойСтроки​

Доступность: Клиент

ПредставлениеГрупповойСтроки: Авто|Строка

Задает представление для строк, являющимися группами в иерархических источниках данных

Для ИсточникДанныхДерево и ИсточникДанныхДеревоПодгружаемый если это УзелДерева и не ТипДанныхЭлементов используется ПредставлениеГрупповойСтроки.

Для источника ДинамическийСписок, если СтрокаДинамическогоСписка является группой, которая не является типом строки динамического списка (см. ИспользуемаяИерархия) - используется ПредставлениеГрупповойСтроки.

Кроме того это представление используется для генерации представления элемента пути в навигационной панели иерархического вида списка в мобильном.

ПредставлениеОтмеченнойСтроки​

Доступность: Клиент

ПредставлениеОтмеченнойСтроки: Авто|Строка

Позволяет переопределить представление для списка отмеченных строк. При описании допустимо использовать привязку к идентификатору строки. В отличие от обычной привязки, вычисляемой без аргумента, тут доступен дополнительный параметр:

  • ОтмеченнаяСтрока(MarkedRow): Объект? - идентификатору строки таблицы. Если Авто, а идентификатор строки реализует Представляемое, используется метод Представление()

ПриВыделенииСтроки​

Доступность: Клиент

ПриВыделенииСтроки: (
Список<ТипИсточника>,
СобытиеСДанными<ТипИсточника.IdType?>)->ничто

Вызывается при изменении выделенной строки, если ИспользоватьВыделениеСтроки = Истина. Данные события - идентификатор выделенной строки списка.

ПриНажатииСтроки​

Доступность: Клиент

ПриНажатииСтроки: (
Список<ТипИсточника>,
СобытиеСДанными<СтрокаСписка<ТипИсточника.ItemDataType|ТипИсточника.NodesDataType>>)->ничто

Вызывается при нажатии на строку списка: либо на пустую область, либо на компонент в этом элементе, который сам не обрабатывает событие ПриНажатии.

ПриРедактированииСтроки​

Доступность: Клиент

ПриРедактированииСтроки: (
Список<ТипИсточника>,
СобытиеПриРедактированииСтроки<ТипИсточника.ItemDataType|ТипИсточника.NodesDataType>)->ничто

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

Если СтандартнаяОбработка = Ложь, то система не вызовет стандартную обработку такого события

ПриСозданииСтроки​

Доступность: Клиент

ПриСозданииСтроки: (
Список<ТипИсточника>,
СобытиеПриСозданииСтроки<ТипИсточника.IdType>)->ничто

Вызывается при создании строки предопределенной командой создания. Если событие определено разработчиком, то команда создания строки будет показана вне зависимости от возможности сконструировать такую строку автоматически.

Если СтандартнаяОбработка = Ложь, то система не вызовет стандартную обработку такого события

ПриСохраненииНастроек​

Доступность: Клиент

ПриСохраненииНастроек: (
Список<ТипИсточника>,
СобытиеСДанными<Массив<СохраненнаяНастройкаСписка>>)->ничто

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

  • при сохранении пользователем новой настройки
  • при обновлении пользователем существующей настройки
  • при удалении пользователем настройки

ПриЧтенииНастроек​

Доступность: Клиент

ПриЧтенииНастроек: (
Список<ТипИсточника>,
СобытиеСДанными<Массив<СохраненнаяНастройкаСписка>>)->ничто

Событие, вызываемое сразу после создания списка для получения сохраненных настроек: фильтров и сортировок. В массив можно передать ранее сохраненные настройки списка.

ПрокруткаПоВертикали​

Доступность: Клиент

ПрокруткаПоВертикали: Авто|Булево

При значении Истина список будет использовать вертикальную прокрутку содержимого.

Авто интерпретируется, как Истина в любом из случаев:

ПустыеСостояния​

Доступность: Клиент

ПустыеСостояния: Авто|ПредставленияПустыхСостоянийСписка|?

Описания представлений пустых состояний для списка.

При Авто система использует стандартные пустые состояния. При Неопределено обработка пустых состояний отключается.

РазмерСтраницы​

Доступность: Клиент

РазмерСтраницы: Авто|Число

Задает размер страницы списка для постраничной навигации. 0 или Авто - автоматически (равно 10).

СоздатьКопию​

Доступность: Клиент ТолькоЧтение

СоздатьКопию: КомандаСПараметром<ТипИсточника.ItemDataType|ТипИсточника.NodesDataType|Массив<ТипИсточника.IdType>>

Команда создания копированием. Может входить в состав свойства КомандыСтроки

Эта команда строки может быть использована только в таблицах форм списка. Вызов этой команды для строки таблицы формы списка приведет к открытию формы нового объекта. Данные нового объекта будут заполнены из объекта на которого указывает строка таблицы.

Удалить​

Доступность: Клиент ТолькоЧтение

Удалить: КомандаСПараметром<ТипИсточника.ItemDataType|ТипИсточника.NodesDataType|Массив<ТипИсточника.IdType>>

Встроенная команда удаления строк. Может входить в состав свойства КомандыСтроки и КомандыСтрокиГруппы Работа команды отличается в зависимости от источника данных.

  • Если источником данных является ИсточникДанныхМассив или ДинамическийСписок, у которого РежимУдаления = Немедленно, команда навсегда удалят объект
  • Если источником данных является ДинамическийСписок, у которого РежимУдаления = ПометкаУдаления, команда доступна при условии, что удаляемый объект еще не помечена на удаление. При выполнении команда помечает объект на удаление.

УдалитьНавсегда​

Доступность: Клиент ТолькоЧтение

УдалитьНавсегда: КомандаСПараметром<ТипИсточника.ItemDataType|ТипИсточника.NodesDataType|Массив<ТипИсточника.IdType>>

Встроенная команда удаления строк. Может входить в состав свойства КомандыСтроки Работа команды отличается в зависимости от источника данных.

  • Если источником данных является ИсточникДанныхМассив или ДинамическийСписок, у которого РежимУдаления = Немедленно, команда недоступна
  • Если источником данных является ДинамическийСписок, у которого РежимУдаления = ПометкаУдаления и удаляемый объект помечен на удаление, команда пытается удалить объект следующим образом:
    • если он упомянут в таблице НеудаленныеOбъекты, удаление не происходит. Появляется всплывающее окно, информирующее о наличии ссылок на удаляемый объект.
    • если объект не упомянут в таблице НеудаленныеOбъекты, то запускается процесс очистки для выбранной строки (или строк).

Методы​

ВыделитьСтроку​

Доступность: Клиент

ВыделитьСтроку(Строка: ТипИсточника.IdType?): Булево
Устанавливает текущую строку списка. Может требовать вызов сервера. Если переданная строка не присутствует в списке по какой-то причине:

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

Если же строка присутствует, будет осуществлена автоматическая прокрутка списка на данную строку так, что бы текущая строка была первой. Если установлен режим навигации ПодгрузкаПриПрокрутке, то будут загружены все записи, пока не найдется текущая строка. Функция в этом случае возвращает Истина.

Так же вызывает событие ПриВыделенииСтроки. Следует соблюдать осторожность, что бы не вызвать вечный цикл.

Идентификатор строки списка, который надо передать в этот метод, зависит от типа источника. См. ВыделеннаяСтрока.

Если в качестве значения передано Неопределено, то выделение будет сброшено.

Если в качестве строки передается строка, которая является дочерней к строке типа УзелДереваПодгружаемый или это строка-группы иерархического источника типа ДинамическийСписок – произойдет рекурсивное раскрытие узлов от корня до узла переданной строки, а затем выделение переданной строки соответственно.

ДобавитьСтрокуВГруппу​

Доступность: Клиент

ДобавитьСтрокуВГруппу(
ДанныеСтроки: ТипИсточника.NodesDataType,
ДопустимыеТипы: Массив<Тип<Объект>>? = Неопределено
): ГруппаКомандногоИнтерфейса<КомандаСПараметром<ТипИсточника.NodesDataType>>|КомандаСПараметром<ТипИсточника.NodesDataType>
Возвращает одну команду или группу команд добавления новой записи в строку-группу.

Параметр ДопустимыеТипы уточняет возвращаемую команду или группу команд строки-группы переданным массивом типов. Если для группы было выявлено несколько команд создания определенного типа – они сократятся до переданного перечня. Иначе – вернется весь выявленный перечень.

Обновить​

Доступность: Клиент

Обновить()
Инициирует принудительное обновление отображаемых данных. Вызов этого метода требуется только если отображаемые данные были изменены не на клиенте, а на сервере. Если отображаемые данные были изменены на клиенте, то они будут обновлены автоматически. В том числе, если на клиенте были изменены (записаны) данные сущностей, отображаемых в динамическом списке.

ОтметитьСтроку​

Доступность: Клиент

ОтметитьСтроку(
Строка: ТипИсточника.IdType,
Отмечен: Булево = Истина,
СДочерними: Булево = Ложь)
Устанавливает и снимает отметку указанной строки.

ОчиститьОтмеченныеСтроки​

Доступность: Клиент

ОчиститьОтмеченныеСтроки()
Очищает список отмеченных строк в таблице. После очистки списка исчезает панель с командами над отмеченным строками.

ПерейтиВУзел​

Доступность: Клиент

ПерейтиВУзел(
ИдУзла: ТипИсточника.IdType?,
АвтоВыделениеСтроки: АвтоВыделениеСтроки? = Неопределено)
Переходит к существующему узлу, переданному в аргументе ИдУзла. Если это узел УзелДереваСДаннымиПодгружаемый – метод игнорируется, если такой узел не был ранее подгружен.

Если ИдУзла – Неопределено, то будет осуществлен переход в корень дерева.

Интерпретация аргумента АвтоВыделениеСтроки:

ПолучитьДанныеСтроки​

Доступность: Клиент

ПолучитьДанныеСтроки(Строка: ТипИсточника.IdType): ТипИсточника.ItemDataType?
Получает данные строки по ее идентификатору. Может вернуть Неопределено, если данные получить не удалось, например, если переданный идентификатор не удовлетворяет фильтру динамического списка.

ПолучитьОтмеченныеСтроки​

Доступность: Клиент

ПолучитьОтмеченныеСтроки(): Массив<ТипИсточника.IdType>
Возвращает идентификаторы отмеченных строк.

Развернуть​

Доступность: Клиент

Развернуть(
ИдУзла: ТипИсточника.IdType?,
УровеньРазворачивания: Число)
Инициирует разворачивание узла типа УзелДереваСДанными, УзелДереваСДаннымиПодгружаемый или строки-группы иерархического источника типа ДинамическийСписок.

Если аргумент УровеньРазворачивания -1 - рекурсивно разворачивает все дочерние узлы.

Игнорируется в мобильной версии.

Свернуть​

Доступность: Клиент

Свернуть(
ИдУзла: ТипИсточника.IdType?,
УровеньСворачивания: Число)
Инициирует сворачивание узла типа УзелДереваСДанными, УзелДереваСДаннымиПодгружаемый или строки-группы иерархического источника типа ДинамическийСписок.

Если ИдУзла – Неопределено, то сворачивание выполняется от корня с учетом аргумента УровеньСворачивания.

Если аргумент УровеньСворачивания -1 - рекурсивно сворачивает все дочерние узлы.

Игнорируется в мобильной версии.

СоздатьНаОсновании​

Доступность: Клиент

СоздатьНаОсновании<ТипСозданияНаОсновании>(ДанныеСтроки: ТипСозданияНаОсновании): ГруппаКомандногоИнтерфейса<КомандаСПараметром<ТипСозданияНаОсновании>>
ТипСозданияНаОсновании: тип команд создания на основании. Ограничения параметра типа: Стд::Коллекции::Массив<SourceType.IdType>, SourceType.ItemDataType.

Возвращает группу командного интерфейса, содержащую команды создания на основании по переданным данным строки

Список унаследованных методов​

Объект​

ВСтроку, ПолучитьТип, Представление

Последнее обновление