Форма BaseListForm (из пространства имен Ultima.Client) наследуется от CommonForm и является общим предком для всех списковых форм справочников и документов:
Форма используется для отображения списка записей и их выбора. |
В классе формы BaseListForm реализованы интерфейсы IRecordBrowser и IRecordSelector.
При наследовании от формы BaseListForm прикладному разработчику могут оказаться полезны следующие методы и свойства ее класса:
•Mode типа ListFormShowMode – возвращает режим списковой формы, который может иметь одно из следующих значений:
▪Browse – режим просмотра записей;
▪SelectSingle – режим выбора одной записи;
▪SelectMultiple – режим выбора нескольких записей;
•SelectRecord(long? id = null, LambdaExpression filter = null) – выбирает запись и возвращает ее идентификатор или null, если запись не была выбрана:
▪id – идентификатор записи, на которой будет установлен курсор в списковой форме (опциональный параметр);
▪filter – выражение, описывающее фильтр, который будет применен к записям, выведенным в списковой форме (опциональный параметр);
•SelectRecords(LambdaExpression filter = null) – выбирает несколько записей и возвращает их идентификаторы или null, если записи не были выбраны:
▪filter – выражение, описывающее фильтр, который будет применен к записям, выведенным в списковой форме (опциональный параметр);
•Browse() – открывает списковую форму, и загружает записи.
Также можно переопределить следующие методы и свойства класса формы BaseListForm:
•SelectedID типа long – возвращает код выбранной записи, если форма была вызвана для выбора;
•SelectedList типа IDList – возвращает коды выбранных записей, если форма была вызвана для выбора;
•LoadRecords() – загружает записи;
•ApplySelectionFilter(LambdaExpression implicitFilter) – применяет неявное выражение фильтра к списку записей формы:
▪implicitFilter – выражение, описывающее применяемый к списку записей формы фильтр;
•LocateRecord(long id) – устанавливает курсор на указанной записи, возвращает true в случае успеха, иначе – false:
▪id – идентификатор записи.