ViewMetadata - класс

Метаданные представления

Definition

Пространство имён: Tessa.Views.Metadata
Сборка: Tessa (в Tessa.dll) Версия: 3.6.0.22

[SerializableAttribute]
[DataContractAttribute]
[KnownTypeAttribute(typeof(ViewColumnCollection))]
[KnownTypeAttribute(typeof(ViewReferenceCollection))]
[KnownTypeAttribute(typeof(ViewAppearanceCollection))]
[KnownTypeAttribute(typeof(ViewParametersCollection))]
[KnownTypeAttribute(typeof(ViewExtensionCollection))]
[KnownTypeAttribute(typeof(ViewSubsetCollection))]
[KnownTypeAttribute(typeof(ValidationResult))]
[KnownTypeAttribute(typeof(ValidationResultItem))]
[KnownTypeAttribute(typeof(SortingColumn))]
[KnownTypeAttribute(typeof(SortingColumnCollection))]
public class ViewMetadata : NamedViewMetadataItem, 
	IViewMetadata, INamedViewMetadataItem, IViewMetadataItem, INamedObject, ISealable, 
	IValidationObject, IValidatable, ICloneable, ITreeMetadata, IExtensionsMetadata, 
	ICaptionHolder, IViewConnectionInfo

<SerializableAttribute>
<DataContractAttribute>
<KnownTypeAttribute(GetType(ViewColumnCollection))>
<KnownTypeAttribute(GetType(ViewReferenceCollection))>
<KnownTypeAttribute(GetType(ViewAppearanceCollection))>
<KnownTypeAttribute(GetType(ViewParametersCollection))>
<KnownTypeAttribute(GetType(ViewExtensionCollection))>
<KnownTypeAttribute(GetType(ViewSubsetCollection))>
<KnownTypeAttribute(GetType(ValidationResult))>
<KnownTypeAttribute(GetType(ValidationResultItem))>
<KnownTypeAttribute(GetType(SortingColumn))>
<KnownTypeAttribute(GetType(SortingColumnCollection))>
Public Class ViewMetadata
	Inherits NamedViewMetadataItem
	Implements IViewMetadata, INamedViewMetadataItem, IViewMetadataItem, INamedObject, 
	ISealable, IValidationObject, IValidatable, ICloneable, ITreeMetadata, 
	IExtensionsMetadata, ICaptionHolder, IViewConnectionInfo

C++

[SerializableAttribute]
[DataContractAttribute]
[KnownTypeAttribute(typeof(ViewColumnCollection))]
[KnownTypeAttribute(typeof(ViewReferenceCollection))]
[KnownTypeAttribute(typeof(ViewAppearanceCollection))]
[KnownTypeAttribute(typeof(ViewParametersCollection))]
[KnownTypeAttribute(typeof(ViewExtensionCollection))]
[KnownTypeAttribute(typeof(ViewSubsetCollection))]
[KnownTypeAttribute(typeof(ValidationResult))]
[KnownTypeAttribute(typeof(ValidationResultItem))]
[KnownTypeAttribute(typeof(SortingColumn))]
[KnownTypeAttribute(typeof(SortingColumnCollection))]
public ref class ViewMetadata : public NamedViewMetadataItem, 
	IViewMetadata, INamedViewMetadataItem, IViewMetadataItem, INamedObject, ISealable, 
	IValidationObject, IValidatable, ICloneable, ITreeMetadata, IExtensionsMetadata, 
	ICaptionHolder, IViewConnectionInfo

[<SerializableAttribute>]
[<DataContractAttribute>]
[<KnownTypeAttribute(typeof(ViewColumnCollection))>]
[<KnownTypeAttribute(typeof(ViewReferenceCollection))>]
[<KnownTypeAttribute(typeof(ViewAppearanceCollection))>]
[<KnownTypeAttribute(typeof(ViewParametersCollection))>]
[<KnownTypeAttribute(typeof(ViewExtensionCollection))>]
[<KnownTypeAttribute(typeof(ViewSubsetCollection))>]
[<KnownTypeAttribute(typeof(ValidationResult))>]
[<KnownTypeAttribute(typeof(ValidationResultItem))>]
[<KnownTypeAttribute(typeof(SortingColumn))>]
[<KnownTypeAttribute(typeof(SortingColumnCollection))>]
type ViewMetadata = 
    class
        inherit NamedViewMetadataItem
        interface IViewMetadata
        interface INamedViewMetadataItem
        interface IViewMetadataItem
        interface INamedObject
        interface ISealable
        interface IValidationObject
        interface IValidatable
        interface ICloneable
        interface ITreeMetadata
        interface IExtensionsMetadata
        interface ICaptionHolder
        interface IViewConnectionInfo
    end

Inheritance: Object ValidationObject ViewMetadataItem NamedViewMetadataItem ViewMetadata

Derived: Tessa.ViewsNullViewMetadata

Implements: ICloneable, INamedObject, ISealable, IValidatable, IValidationObject, IViewConnectionInfo, ICaptionHolder, INamedViewMetadataItem, ITreeMetadata, IViewMetadata, IViewMetadataItem, IExtensionsMetadata

Конструкторы

ViewMetadata

Initializes a new instance of the ViewMetadata class. Инициализирует новый экземпляр класса Object.

Свойства

Alias	Gets or sets Псевдоним элемента метаданных (Унаследован от NamedViewMetadataItem)
Appearance	Gets or sets Псевдоним внешнего вида строки представления
Appearances	Gets Настройки внешнего вида представления
AutoWidthRowLimit	Количество строк в наборе данных пределах которого работает автоматический расчет ширини столбцов
Caption	Gets or sets the Название представления.
Columns	Gets список столбцов представления
ConnectionAlias	Алиас строки подключения (из конфигурационного файла веб сервиса `app.json`) к БД, на которой будет выполняться представление вместо дефолтной базы. В конфигурационном файле можно указать подключение к любой СУБД. Если, например, основная база - MSSQL, а подключение к базе Postgres, то запрос генерируется по правилам Postgres; если же база какая-то другая (например, Oracle), то по умолчанию используются правила генерации для MSSQL. С помощью данного параметра можно прописать подключение к другой базе, в том числе не к базе Tessa, а, например, к какой-то другой информационнной системе. Укажите null или пустую строку, если используется соединение по умолчанию. Также на алиас соединения влияет одноимённая настройка в метаинформации представления. Для использования этой настройки требуется модуль лицензии "Кластеризация". Он включён в лицензии Enterprise.
DefaultSortColumn	Gets or sets Псевдоним колонки по умолчанию
DefaultSortDirection	Gets or sets Направление сортировки
DefaultSortingColumns	Gets Список столбцов по которым осуществляется сортировка
EnableAutoWidth	Gets or sets a value indicating whether Признак автоматического расчета ширины столбцов представления
ExportDataPageLimit	Gets or sets количество строк запрашиваемых в режиме пейджинга при выгрузке данных
Extensions	Gets возвращает список имен типов расширений
GroupingColumn	Gets or sets Псевдоним столбца по которому включена группировка по умолчанию
IsSealed	Признак того, что объект был защищён от изменений. (Унаследован от ViewMetadataItem)
Kind	Gets or sets Вид отображения представления
ModifiedDateTime
MultiSelect	Gets or sets a value indicating whether Признак возможности множественного выбора строк в представлении. True - возможно выбрать множество строк. False - возможно выбрать одну строку.(режим по умолчанию)
PageLimit	Gets or sets количество строк возвращаемых в режиме пейджинга
Paging	Gets or sets Поддержка страничного вывода
Parameters	Gets Параметры представления
QuickSearchParam	Gets or sets Псевдоним параметра быстрого поиска
References	Gets список ссылок представления
RowCounterVisible	Gets or sets a value indicating whether Признак необходимости расчета и отображения количества строк
RowCountSubset	Gets or sets Алиас подмножества используемого для расчета количество строк, которые доступны в обрабатываемом представлении.
SelectionMode	Gets or sets Режим выделения элементов представления
Subsets	Gets список подзапросов представления
TreatAsSingleQuery	Признак выполнения запроса как обычный запрос на выборку без использования серверного механизма кэширования представлений в виде хранимых процедур
TreeGroup	Имя столбца содержащего признак того, что строка содержит только информацию о группе
TreeGroupDisplayValue	Имя столбца содержащего отображаемое имя группы
TreeGroupId	Имя столбца содержащего идентификатор группы строки
TreeGroupParentId	Имя столбца содержащего идентификатор родительской группы
TreeHasChildrenColumn	Gets or sets Алиас колонки из представления, которая должна содержать значение типа bit, которое трактуется как признак наличия дочерних узлов. Если значение = 1, система показывает плюсик для разворачивания элемента, если 0 - не показывает. Необязательное, если не задано, то система будет показывать плюсики у всех элементов дерева до первой попытки их развернуть, когда выяснится, есть или нет на самом деле у него дочерние элементы. Параметр обязателен при Kind: Tree.
TreeId	Имя столбца идентификатора строки
TreeParentId	Имя столбца идентификатора родительской строки
TreeRefParam	Gets or sets Алиас параметра из текущего вью, который будет использоваться для получения узлов дерева с определенным родителем. Для получения верхнего уровня, в параметр передается NULL, для получения дочерних узлов - в параметр передается значение из RefColumn, которое трактуется как идентификатор текущего узла дерева. Параметр обязателен при Kind: Tree.
ValidationResult	Gets or sets Информация о валидности представления

Методы

CheckSealed	Проверка защиты метаданных от изменения (Унаследован от ViewMetadataItem)
Clone	Создает новый объект, который является копией текущего экземпляра. (Переопределяет ViewMetadataItemClone)
Deserialize	The deserialize.
Equals	Determines whether the specified object is equal to the current object. (Унаследован от Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Унаследован от Object)
GetHashCode	Serves as the default hash function. (Унаследован от Object)
GetName	Возвращает имя объекта (Унаследован от NamedViewMetadataItem)
GetType	Gets the Type of the current instance. (Унаследован от Object)
GetValidationName	Возвращает строку, определяющую имя объекта, или null, если имя объекта ещё неизвестно или объект не содержит имени. (Переопределяет NamedViewMetadataItemGetValidationName)
InternalSeal	Включение режимы защиты от изменения для коллекций объектов принадлежащих классу (Переопределяет ViewMetadataItemInternalSeal)
IsValid	Выполняет проверку объекта на валидность и возвращает признак того, что объект является валидным. (Унаследован от ValidationObject)
MemberwiseClone	Creates a shallow copy of the current Object. (Унаследован от Object)
OnDeserialized	Вызывается после процесса десериализации элемента метаданных Может перекрываться в потомках (Унаследован от ViewMetadataItem)
OnDeserializedMethod	Вызывается после десериализации элемента метаданных (Унаследован от ViewMetadataItem)
OnDeserializing	Вызывается перед десериализацией элемента метаданных Может перекрываться в потомках (Унаследован от ViewMetadataItem)
OnDeserializingMethod	Вызывается перед десериализацией элемента метаданных (Унаследован от ViewMetadataItem)
OnSerialized	Вызывается после окончания процесса сериализации элемента метаданных. Может перекрываться в потомках (Унаследован от ViewMetadataItem)
OnSerializedMethod	Вызывается после окончания процесса сериализации элемента метаданных. (Унаследован от ViewMetadataItem)
OnSerializing	Вызывается перед началом процесса сериализации элемента метаданных. Может перекрываться в потомках (Унаследован от ViewMetadataItem)
OnSerializingMethod	Вызывается перед началом процесса сериализации элемента метаданных. (Унаследован от ViewMetadataItem)
Seal	Защищает объект от изменений. (Унаследован от ViewMetadataItem)
Serializing	The serializing.
ToString	Returns a string that represents the current object. (Унаследован от Object)
Validate	Выполняет валидацию объекта и всех его дочерних объектов. (Унаследован от ValidationObject)
Validate(IValidationResultBuilder)	Выполняет валидацию текущего объекта и всех его дочерних объектов. (Унаследован от ValidationObject)
ValidateInternal	Выполняет валидацию текущего объекта и всех его дочерних объектов. (Переопределяет NamedViewMetadataItemValidateInternal(IValidationResultBuilder))

Поля

DefaultExportDataPageLimit	Размер страницы для экспорта по умолчанию.
DefaultPageLimit	Размер страницы по умолчанию.
isDeserializing	Признак десериализации объекта (Унаследован от ViewMetadataItem)
isSerializing	Признак сериализации объекта (Унаследован от ViewMetadataItem)

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

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

См. также

Ссылки

Tessa.Views.Metadata - пространство имён