IViewMetadata - интерфейс

Интерфейс метаданных представления.

Definition

Пространство имён: Tessa.Views.Metadata
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4
C#
public interface IViewMetadata : INamedViewMetadataItem, 
	IViewMetadataItem, INamedObject, ISealable, IValidationObject, IValidatable, 
	ICloneable, ITreeMetadata, IExtensionsMetadata, ICaptionHolder, IViewConnectionInfo
Implements
ICloneable, INamedObject, ISealable, IValidatable, IValidationObject, IViewConnectionInfo, ICaptionHolder, INamedViewMetadataItem, ITreeMetadata, IViewMetadataItem, IExtensionsMetadata

Свойства

Alias Псевдоним элемента метаданных
(Унаследован от INamedViewMetadataItem)
Appearance Псевдоним внешнего вида строки представления.
Appearances Настройки внешнего вида представления.
AutoSelectFirstRow Признак того, что при открытии представления должна быть автоматически выделена первая строка.
AutoWidthRowLimit Количество строк в наборе данных, в пределах которого работает автоматический расчет ширины столбцов.
Caption Заголовок объекта. Используется в UI.
(Унаследован от ICaptionHolder)
CollapseGroups Признак необходимости сворачивания группировок по умолчанию.
Columns Список столбцов представления.
ConnectionAlias

Алиас строки подключения (из конфигурационного файла веб сервиса `app.json`) к БД, на которой будет выполняться представление вместо дефолтной базы. В конфигурационном файле можно указать подключение к любой СУБД. Если, например, основная база - MSSQL, а подключение к базе Postgres, то запрос генерируется по правилам Postgres; если же база какая-то другая (например, Oracle), то по умолчанию используются правила генерации для MSSQL.

С помощью данного параметра можно прописать подключение к другой базе, в том числе не к базе Tessa, а, например, к какой-то другой информационнной системе.

Укажите null или пустую строку, если используется соединение по умолчанию. Также на алиас соединения влияет одноимённая настройка в метаинформации представления.

Для использования этой настройки требуется модуль лицензии "Кластеризация". Он включён в лицензии Enterprise.


(Унаследован от IViewConnectionInfo)
DefaultSortColumn Алиас колонки по умолчанию.
DefaultSortDirection Направление сортировки.
DefaultSortingColumns Список столбцов, по которым осуществляется сортировка.
EnableAutoWidth Признак автоматического расчета ширины столбцов представления.
ExportDataPageLimit Количество строк, запрашиваемых в режиме пейджинга при выгрузке данных.
Extensions Gets возвращает список имен типов расширений
(Унаследован от IExtensionsMetadata)
GroupingColumn Псевдоним столбца, по которому включена группировка по умолчанию.
IsSealedПризнак того, что объект был защищён от изменений.
(Унаследован от ISealable)
Kind Gets or sets Вид отображения представления
(Унаследован от ITreeMetadata)
ModifiedDateTime Дата и время последнего изменения метаданных модели.
MultiSelect Признак возможности множественного выбора строк в представлении. True - возможно выбрать множество строк. False - возможно выбрать одну строку (режим по умолчанию).
PageLimit Количество строк, возвращаемых в режиме пейджинга.
Paging Поддержка постраничного вывода.
Parameters Параметры представления.
QuickSearchParam Псевдоним параметра быстрого поиска.
References Список ссылок представления.
RowCounterVisible Признак необходимости расчета и отображения количества строк.
RowCountSubset Алиас подмножества, используемого для расчета количество строк, которые доступны в обрабатываемом представлении.
SelectionMode Режим выделения элементов представления.
Subsets Список подзапросов представления.
TagsPosition Расположение контрола со списком тегов.
TreatAsSingleQuery Признак выполнения запроса как обычного запроса на выборку без использования серверного механизма кэширования представлений в виде хранимых процедур.
TreeGroup Имя столбца, содержащего признак того, что строка содержит только информацию о группе.
TreeGroupDisplayValue Имя столбца, содержащего отображаемое имя группы.
TreeGroupId Имя столбца, содержащего идентификатор группы строки.
TreeGroupParentId Имя столбца, содержащего идентификатор родительской группы.
TreeHasChildrenColumn Gets or sets Алиас колонки из представления, которая должна содержать значение типа bit, которое трактуется как признак наличия дочерних узлов. Если значение = 1, система показывает плюсик для разворачивания элемента, если 0 - не показывает. Необязательное, если не задано, то система будет показывать плюсики у всех элементов дерева до первой попытки их развернуть, когда выяснится, есть или нет на самом деле у него дочерние элементы. Параметр обязателен при Kind: Tree.
(Унаследован от ITreeMetadata)
TreeId Имя столбца идентификатора строки.
TreeParentId Имя столбца идентификатора родительской строки.
TreeRefParam Gets or sets Алиас параметра из текущего вью, который будет использоваться для получения узлов дерева с определенным родителем. Для получения верхнего уровня, в параметр передается NULL, для получения дочерних узлов - в параметр передается значение из RefColumn, которое трактуется как идентификатор текущего узла дерева. Параметр обязателен при Kind: Tree.
(Унаследован от ITreeMetadata)
ValidationResult Информация о валидности представления.

Методы

CloneCreates a new object that is a copy of the current instance.
(Унаследован от ICloneable)
GetName Возвращает имя объекта.
(Унаследован от INamedObject)
IsValidВыполняет проверку объекта на валидность и возвращает признак того, что объект является валидным.
(Унаследован от IValidatable)
SealЗащищает объект от изменений.
(Унаследован от ISealable)
ValidateВыполняет валидацию текущего объекта и всех его дочерних объектов.
(Унаследован от IValidationObject)

Методы расширения

GetLocalizedCaption Осуществляет локализацию заголовка объекта captionHolder если требуется
(Определяется ViewMetadataHelper)
IsFilteringEnabled Осуществляет проверку возможности фильтрации представления. Фильтрация доступна при наличии хотя бы одного не скрытого параметра.
(Определяется ViewMetadataHelper)
IsSubsetsModeEnabled Овеществляет проверку возможности создания подмножеств
(Определяется ViewMetadataHelper)
TryGetCardColumnId Помощник получения колонки с идентификатором карточки, которую можно открыть из представления.
(Определяется ViewMetadataHelper)
TryGetCardIdInfo Помощник получения данных об идентифицирующих карточку колонках.
(Определяется ViewMetadataHelper)
TryGetPrefixedColumnId Помощник получения названия колонки с идентификатором, по начальному имени колонки.
(Определяется ViewMetadataHelper)
TryGetPrefixedStringColumn Помощник получения названия строковой колонки, по начальному имени колонки.
(Определяется ViewMetadataHelper)
TryGetViewReferenceInfo Помощник получения информации о ссылочных колонках представления.
(Определяется ViewMetadataHelper)
Validate Выполняет валидацию объекта и всех его дочерних объектов.
(Определяется ValidationExtensions)

См. также