CardMetadata - класс

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

Definition

Пространство имён: Tessa.Cards.Metadata
Сборка: Tessa (в Tessa.dll) Версия: 4.1.3+7e2b1422f9b8c7c41fbbc4b151a843bed05319ab
C#
public sealed class CardMetadata : CardSchemeSerializableObject, 
	ICardMetadata, ISealable
Inheritance
Object    ValidationObject    CardSerializableObject    CardSchemeSerializableObject    CardMetadata
Implements
ICardMetadata, ISealable

Заметки

Метаинформация включает в себя связь между именами и идентификаторами таблиц и колонок (физических и комплексных).

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

CardMetadataСоздаёт экземпляр класса с параметрами по умолчанию.
CardMetadata(CardMetadataSectionCollection, CardType, CardMetadataNormalizationInfo, HashSetString, CardSerializableObject, IValidationResultBuilder) Создаёт экземпляр класса с указанием списка секций и типа карточки.
CardMetadata(HashSetString, CardSerializableObject, CardMetadataSectionCollection, CardMetadataEnumerationCollection, CardTypeCollection, CardMetadataNormalizationInfo, SealableListGuid, IValidationResultBuilder) Создаёт экземпляр класса с указанием списка секций, перечислений и типов карточек.

Свойства

ContainsFormatVersion Признак того, что при десериализации объекта формат версии должен быть получен вызовом TryGetFormatVersionFromStorage(IReadOnlyDictionaryString, Object). Актуально для типов карточки CardType.
(Унаследован от CardSerializableObject)
Empty Метаинформация, не включающая в себя никаких сведений.
IsSealed Признак того, что объект был защищён от изменений.
(Унаследован от CardSerializableObject)
Reference Имя глобального объекта, на который ссылается данный объект.
(Унаследован от CardSerializableObject)

Методы

Clear Удаляет всю метаинформацию.
CreateAndEnsureSealingT Создаёт объект типа T посредством конструктора по умолчанию и защищает его от изменений, если текущий объект также защищён от изменений.
(Унаследован от CardSerializableObject)
CreateCopyAsync

Создаёт объект, являющийся неглубокой (shallow) копией указанного объекта ICardMetadata. Все коллекции доступны для изменения, например, возможно заменить один тип карточки на другой.

При этом сами объекты внутри коллекции (типы карточек, секции и др.) не клонируются, а ссылаются на те же объекты, что и в cardMetadata.

DeserializeAsync Асинхронно выполняет десериализацию полей объекта из заданного хранилища. Возвращает объект, используемый далее при десериализации (обычно возвращает текущий объект this кроме тех случаев, когда возвращается объект-суррогат).
(Унаследован от CardSerializableObject)
DeserializeFromJsonAsync(String, ICardSerializableContext, CancellationToken) Десериализует объект и его дочерние объекты из заданного текстового JSON с сохраняемыми типами данных.
(Унаследован от CardSerializableObject)
DeserializeFromStorageAsync(DictionaryString, Object, ICardSerializableContext, CancellationToken) Десериализует объект и его дочерние объекты из заданного хранилища Dictionary<string, object?>.
(Унаследован от CardSerializableObject)
DeserializeFromStorageCoreAsync Десериализует объект и его дочерние объекты из заданного хранилища Dictionary<string, object?>.
(Унаследован от CardSerializableObject)
DeserializeFromStorageInternalAsync Выполняет десериализацию объекта и всех его дочерних объектов из хранилища Dictionary<string, object?>.
(Переопределяет CardSerializableObjectDeserializeFromStorageInternalAsync(ICardSerializableContext, DictionaryString, Object, CancellationToken))
EqualsDetermines whether the specified object is equal to the current object.
(Унаследован от Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Унаследован от Object)
GetCardTypesAsync Возвращает список типов карточек.
GetDamagedCardTypeIDListAsync Возвращает список идентификаторов повреждённых типов карточек. Собственно типы карточек можно получить посредством сервиса типов карточек.
GetEnumerationsAsync Возвращает список перечислений.
GetGlobalReferencesAsync Возвращает список глобальных объектов (CardTypeForm, CardTypeBlock, CardTypeControl), совместно использующиеся в типах карточек.
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetMetadataForTypeAsync Возвращает выборку из метаинформации, которая относится только к заданному типу карточек. В возвращённую выборку не передаются перечисления.
GetNormalizationInfoAsync Возвращает метаинформацию по справочникам нормализации, используемых в служебных таблицах.
GetSectionsAsync Возвращает метаинформацию по секциям карточек.
GetTypeGets the Type of the current instance.
(Унаследован от Object)
GetValidationName Возвращает строку, определяющую имя объекта, или null, если имя объекта ещё неизвестно или объект не содержит имени.
(Унаследован от ValidationObject)
GetValidationResultAsyncВозвращает результат валидации при построении метаинформации.
IsValidВыполняет проверку объекта на валидность и возвращает признак того, что объект является валидным.
(Унаследован от ValidationObject)
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
OnDeserializedAsync Выполняется после успешной десериализации объекта и всех его дочерних объектов.
(Переопределяет CardSerializableObjectOnDeserializedAsync(ICardSerializableContext, CancellationToken))
OnDeserializingAsync Выполняется перед десериализацией объекта и всех его дочерних объектов.
(Переопределяет CardSerializableObjectOnDeserializingAsync(ICardSerializableContext, CancellationToken))
PrepareForPasteAsync Подготавливает объект после чтения из буфера обмена.
(Унаследован от CardSerializableObject)
RepairAsync(ICardSchemeInfoProvider, TypeRepairLevel, CancellationToken) Метод восстанавливает объект к работоспособному состоянию в соответствии со схемой. Этот процесс включает удаление данных из текущего объекта, которые имеют отношение к схеме, но фактически в ней отсутствуют.
(Унаследован от CardSchemeSerializableObject)
RepairAsync(ICardSchemeInfoProvider, IValidationResultBuilder, TypeRepairLevel, CancellationToken) Метод восстанавливает объект к работоспособному состоянии в соответствии со схемой. Этот процесс включает удаление данных из текущего объекта, которые имеют отношение к схеме, но фактически в ней отсутствуют.
(Унаследован от CardSchemeSerializableObject)
RepairInternalAsync Метод восстанавливает объект к работоспособному состоянии в соответствии со схемой. Этот процесс включает удаление данных из текущего объекта, которые имеют отношение к схеме, но фактически в ней отсутствуют.
(Переопределяет CardSchemeSerializableObjectRepairInternalAsync(ICardSchemeInfoProvider, IValidationResultBuilder, TypeRepairLevel, CancellationToken))
Seal Защищает объект от изменений.
(Унаследован от CardSerializableObject)
SealInternal Защищает объект от изменений. Метод может быть переопределён в классах-наследниках.
(Переопределяет CardSerializableObjectSealInternal)
SerializeAsync Асинхронно выполняет сериализацию полей объекта в заданное хранилище.
(Унаследован от CardSerializableObject)
SerializeToJsonAsync Сериализует объект и его дочерние объекты в форме текстового JSON с сохраняемыми типами данных.
(Унаследован от CardSerializableObject)
SerializeToStorageAsync(CancellationToken) Сериализует объект и его дочерние объекты в возвращаемое хранилище Dictionary<string, object?>.
(Унаследован от CardSerializableObject)
SerializeToStorageAsync(DictionaryString, Object, CancellationToken) Сериализует объект и его дочерние объекты в заданное хранилище Dictionary<string, object?>.
(Унаследован от CardSerializableObject)
SerializeToStorageCoreAsync Сериализует объект и его дочерние объекты в заданное хранилище Dictionary<string, object?>.
(Унаследован от CardSerializableObject)
SerializeToStorageInternalAsync Выполняет сериализацию текущего объекта и всех его дочерних объектов в хранилище Dictionary<string, object?>.
(Переопределяет CardSerializableObjectSerializeToStorageInternalAsync(ICardSerializableContext, DictionaryString, Object, CancellationToken))
SerializeToStorageWithoutGlobalReferencesAsync Сериализует объект и его дочерние объекты в возвращаемое хранилище Dictionary<string, object?> без использования глобальных ссылок GetGlobalReferencesAsync(CancellationToken).
SetCardTypesAsync Устанавливает список типов карточек.
SetDamagedCardTypeIDListAsync Устанавливает список идентификаторов повреждённых типов карточек. Собственно типы карточек можно получить посредством сервиса типов карточек.
SetEnumerationsAsync Устанавливает список перечислений.
SetGlobalReferencesAsync Устанавливает список глобальных объектов (CardTypeForm, CardTypeBlock, CardTypeControl, CardTypeValidator, CardTypeExtension), совместно использующиеся в типах карточек.
SetNormalizationInfoAsync Устанавливает метаинформацию по справочникам нормализации, используемых в служебных таблицах.
SetSectionsAsync Метаинформация по секциям карточек.
SetValidationResultAsyncУстанавливает результат валидации при построении метаинформации.
ToStringReturns a string that represents the current object.
(Унаследован от Object)
Validate Выполняет валидацию объекта и всех его дочерних объектов.
(Унаследован от ValidationObject)
Validate(IValidationResultBuilder)Выполняет валидацию текущего объекта и всех его дочерних объектов.
(Унаследован от ValidationObject)
ValidateInternalВыполняет валидацию текущего объекта и всех его дочерних объектов.
(Переопределяет ValidationObjectValidateInternal(IValidationResultBuilder))

Поля

SkipGlobalReferencesKey Ключ в Info, по которому может быть расположен признак того, что метаинформация сериализуется без глобальных ссылок GetGlobalReferencesAsync(CancellationToken).

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

GetDocumentStateNameAsync Возвращает название состояния в типовом решении по его идентификатору. Если состояние не является стандартным, то значение запрашивается из метаданных секции KrConstantsKrDocState.
(Определяется KrProcessSharedExtensions)
GetLanguageCaptionByIDAsync Retrieves the caption of a language associated with a given language identifier.
(Определяется ApiAccessTokenHelper)
GetLanguageCodeByIDAsync Retrieves the language code associated with a given language identifier.
(Определяется ApiAccessTokenHelper)
GetStageStateNameAsync Возвращает название состояния этапа. Если состояние не является стандартным, то значение запрашивается из метаданных секции KrConstantsKrStageState.
(Определяется KrProcessSharedExtensions)
TryGetDocumentStateNameAsync Возвращает название состояния в типовом решении по его идентификатору. Если состояние не является стандартным, то значение запрашивается из метаданных секции KrConstantsKrDocState.
(Определяется KrProcessSharedExtensions)
TryGetStageStateNameAsync Возвращает название состояния этапа. Если состояние не является стандартным, то значение запрашивается из метаданных секции KrConstantsKrStageState.
(Определяется KrProcessSharedExtensions)

См. также