CardInfoStorageObject - класс

Базовый класс для объектов карточек, являющихся декораторами для хранилища, с поддержкой дополнительной пользовательской информации.

Definition

Пространство имён: Tessa.Cards
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4
C#
[StorageObjectGeneratorAttribute]
public abstract class CardInfoStorageObject : CardStorageObject
Inheritance
Object    StorageObject    ValidationStorageObject    CardStorageObject    CardInfoStorageObject
Derived
Подробнее

Заметки

Строго типизированный декоратор для хранилища Dictionary<string, object?>, поддерживающий валидацию свойств, раздел для дополнительной пользовательской информации, очистку хранилища от избыточных и пользовательских данных, а также динамический доступ к хранилищу.

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

CardInfoStorageObjectСоздаёт экземпляр класса с указанием хранилища, декоратором для которого является создаваемый объект.

Свойства

Dynamic Объект, осуществляющий доступ к текущему объекту через позднее связывание свойств.
DynamicInfo Объект, осуществляющий доступ к дополнительной пользовательской информации по текущему объекту через позднее связывание свойств.
Info Дополнительная пользовательская информация.

Методы

CleanВыполняет очистку хранилища от избыточных данных.
(Переопределяет CardStorageObjectClean)
CleanCollectionAndSetNullIfEmpty Очищает коллекцию, найденную по ключу key, после чего устанавливает null на место коллекции, если она стала пустой.
(Унаследован от StorageObject)
ClearCache Очищает внутренний кэш декораторов.
(Унаследован от StorageObject)
ContainsKey Возвращает признак того, что элемент с заданным ключом содержится в хранилище.
(Унаследован от StorageObject)
EnsureCacheResolved Инициализирует объект-обёртку для всех значений, в т.ч. для вложенных объектов. Рекомендуется выполнять при создании заполненного объекта перед асинхронным обращением к его вложенным объектам.
(Переопределяет StorageObjectEnsureCacheResolved)
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)
FromJsonCore Устанавливает содержимое объекта в соответствии с данными, десериализованными из текстового JSON. Возвращает текущий объект для цепочки вызовов. Рассмотрите использование метода ToTypedJson(Boolean) для сериализации с сохранением полной информации по типам, которую можно будет восстановить в методе FromTypedJson.
(Унаследован от StorageObject)
FromTypedJsonCore Устанавливает содержимое объекта в соответствии с данными, десериализованными из текстового JSON с сохранением типов. Используйте метод ToTypedJson(Boolean) для сериализации с сохранением типов. Для десериализации других объектов, у которых нет метода FromTypedJson (например, request/response), используйте метод DeserializeFromTypedJson(String), записав полученную структуру в объект obj.SetStorage(storage).
(Унаследован от StorageObject)
GetT(String) Возвращает строго типизированное значение объекта из хранилища по заданному ключу.
(Унаследован от StorageObject)
GetT(String, FuncObject) Возвращает строго типизированное значение объекта из хранилища по заданному ключу с указанием фабрики defaultValueFunc, создающей значение по умолчанию и добавляющей его в хранилище, если оно было равно null.
Метод выбрасывает исключение ArgumentException в случае, если фабрика defaultValueFunc вернула null.
(Унаследован от StorageObject)
GetDictionaryT Возвращает декоратор для коллекции пар ключ / значение, полученный из хранилища по заданному ключу или созданный посредством заданной фабрики defaultDictionaryFunc, и добавленный в хранилище, если он там отсутствует. Метод выбрасывает исключение ArgumentException в случае, если фабрика defaultDictionaryFunc вернула null.
(Унаследован от StorageObject)
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetListT Возвращает декоратор для коллекции объектов, полученный из хранилища по заданному ключу или созданный посредством заданной фабрики defaultListFunc, и добавленный в хранилище, если он там отсутствует. Метод выбрасывает исключение ArgumentException в случае, если фабрика defaultListFunc вернула null.
(Унаследован от StorageObject)
GetObjectData Записывает сериализованные данные текущего объекта в указанный объект [System.Runtime.Serialization.SerializationInfo].
(Унаследован от StorageObject)
GetStorage Возвращает хранилище Dictionary<string, object>, декоратором для которого является текущий объект.
(Унаследован от StorageObject)
GetTypeGets the Type of the current instance.
(Унаследован от Object)
Init Инициализирует значение объекта с заданным ключом, если он отсутствовал в хранилище.
(Унаследован от StorageObject)
InitNotNull Инициализирует значение объекта с заданным ключом, если он отсутствовал в хранилище или был равен null, посредством фабрики объектов.
(Унаследован от StorageObject)
IsValidВыполняет проверку объекта на валидность и возвращает признак того, что объект является валидным.
(Унаследован от ValidationStorageObject)
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
ObjectCanExistInStorageByKeyT Возвращает признак того, что значение, доступное по ключу key, может содержаться в хранилище и в таком случае должно проходить проверку на валидность посредством функции valueIsValid, причём значение для проверки доступно из хранилища по ключу key.
(Унаследован от ValidationStorageObject)
ObjectCanExistInStorageByValueT Возвращает признак того, что значение, доступное по ключу key, может содержаться в хранилище и в таком случае должно проходить проверку на валидность посредством функции valueIsValid, причём значение для проверки определяется по функции, передаваемой первым параметром метода Validate.
(Унаследован от ValidationStorageObject)
ObjectExistsInStorageByKey(String) Возвращает признак того, что значение, доступное по ключу key, содержится в хранилище.
(Унаследован от ValidationStorageObject)
ObjectExistsInStorageByKeyT(String, FuncT, Boolean) Возвращает признак того, что значение, доступное по ключу key, содержится в хранилище и проходит проверку на валидность посредством функции valueIsValid, причём значение для проверки доступно из хранилища по ключу key.
(Унаследован от ValidationStorageObject)
ObjectExistsInStorageByValueT Возвращает признак того, что значение, доступное по ключу key, содержится в хранилище и проходит проверку на валидность посредством функции valueIsValid, причём значение для проверки определяется по функции, передаваемой первым параметром метода Validate.
(Унаследован от ValidationStorageObject)
Remove Удаляет объект с заданным ключом из хранилища.
(Унаследован от StorageObject)
RemoveSystemInfo

Удаляет системную информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом SystemKeyPrefix.

Внимание! После выполнения метода из карточки исчезнут важные сведения, такие как информация об изменённых полях или о состоянии строк коллекционных и древовидных секций.

RemoveUserInfo Удаляет пользовательскую информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом UserKeyPrefix.
Set Устанавливает значение в хранилище по заданному ключу. При этом не изменяется внутренний кэш декораторов, поэтому метод следует использовать только для примитивных типов.
(Унаследован от StorageObject)
SetNull Устанавливает значение null для элемента по заданному ключу и удаляет предыдущий элемент из внутреннего кэша декораторов.
(Унаследован от StorageObject)
SetNullIfEmptyEnumerable Устанавливает равным null элемент с ключом key, если он является пустым перечислением IEnumerable.
(Унаследован от StorageObject)
SetStorage(DictionaryString, Object) Устанавливает хранилище Dictionary<string, object>, декоратором для которого является текущий объект, посредством копирования значений из заданного хранилища. Если текущий объект реализует IStorageNotificationReceiver, то для него вызывается метод NotifyStorageUpdated.
(Унаследован от StorageObject)
SetStorage(IStorageObjectProvider) Устанавливает хранилище Dictionary<string, object>, декоратором для которого является текущий объект, посредством копирования значений из хранилища заданного объекта. Если текущий объект реализует IStorageNotificationReceiver, то для него вызывается метод NotifyStorageUpdated.
(Унаследован от StorageObject)
SetStorageValue Устанавливает значение объекта, реализующего IStorageProvider, в хранилище по заданному ключу. При этом также изменяется внутренний кэш декораторов, поэтому метод следует использовать для декораторов.
(Унаследован от StorageObject)
ToDynamic Возвращает объект, осуществляющий доступ к хранилищу, декоратором для которого является текущий объект, через позднее связывание.
(Унаследован от StorageObject)
ToJson Сериализует объект в текстовый JSON. Рассмотрите использование метода ToTypedJson(Boolean) для сериализации с сохранением полной информации по типам, которую можно будет восстановить в методе FromTypedJson.
(Унаследован от StorageObject)
ToStringReturns a string that represents the current object.
(Унаследован от Object)
ToTypedJson Сериализует объект в текстовый JSON с сохранением информации по типам для всех подобъектов, в т.ч. для Info. Используйте метод FromTypedJson для десериализации. Для сериализации других объектов, у которых нет метода ToTypedJson (например, request/response), используйте метод SerializeToTypedJson(IDictionaryString, Object, Boolean), передав в него структуру объекта obj.GetStorage().
(Унаследован от StorageObject)
TryGetT Возвращает строго типизированное значение объекта из хранилища по заданному ключу или default(T), если объект по заданному ключу не найден.
(Унаследован от StorageObject)
TryGetDictionaryT Возвращает строго типизированное значение объекта Dictionary<string, object> из хранилища по заданному ключу или default(T), если объект по заданному ключу не найден.
(Унаследован от StorageObject)
TryGetInfo Возвращает дополнительную пользовательскую информацию по текущему объекту или null, если информация ещё не была задана.
TryGetListT Возвращает строго типизированное значение объекта List<object> из хранилища по заданному ключу или default(T), если объект по заданному ключу не найден.
(Унаследован от StorageObject)
TryGetString Возвращает строковое представление для значения объекта из хранилища по заданному ключу или null, если объект по заданному ключу не найден.
(Унаследован от StorageObject)
Validate Выполняет валидацию объекта и всех его дочерних объектов.
(Унаследован от ValidationStorageObject)
Validate(IValidationResultBuilder)Выполняет валидацию текущего объекта и всех его дочерних объектов.
(Унаследован от ValidationStorageObject)
ValidateInternalВыполняет валидацию текущего объекта и всех его дочерних объектов.
(Переопределяет ValidationStorageObjectValidateInternal(IValidationResultBuilder))

Поля

DefaultCapacity Default capacity used when creating instance of CardInfoStorageObject with empty storage DictionaryTKey, TValue.
InfoKey 

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

AddKrProcessClientCommands Добавляет в указанное хранилище список клиентских команд.
(Определяется KrProcessSharedExtensions)
AreButtonsIgnored Получает из заданного хранилища значение флага показывающего, что при загрузке карточки не надо добавлять в ответ информацию по тайлам вторичных процессов.
(Определяется KrProcessSharedExtensions)
ConsiderHiddenStages Возвращает значение, показывающее, что в карточку должны быть загружены скрытые этапы маршрута.
(Определяется KrProcessSharedExtensions)
ConsiderSkippedStages Возвращает значение из заданного хранилища, показывающее, требуется ли отображать пропущенные этапы.
(Определяется KrProcessSharedExtensions)
DontHideStages Добавляет в указанное хранилище значение, показывающее, необходимо ли загружать в карточку скрытые этапы маршрута или нет.
(Определяется KrProcessSharedExtensions)
Get
(Определяется ComHelper)
GetHasRecalcChanges Возвращает значение, показывающее, что после пересчёта были изменения в маршруте или нет. Информация добавляется только при выставленном флаге HasChangesToInfo.
(Определяется KrProcessSharedExtensions)
GetIgnorePermissionsWarning Возвращает признак того, что при сохранении карточки могут быть не указаны токены безопасности, поэтому не следует показывать соответствующее предупреждение. Если признак не был установлен, то возвращается false.
(Определяется CardRequestExtensions)
GetInfoAboutChanges Возвращает режим вывода информации об изменениях в маршруте после пересчёта или значение по умолчанию для типа, если хранилище его не содержало.
(Определяется KrProcessSharedExtensions)
GetKrProcessClientCommands Возвращает из указанного хранилища список клиентских команд или значение по умолчанию для типа, если оно их не содержало.
(Определяется KrProcessSharedExtensions)
GetKrProcessInstance Возвращает информацию об экземпляре процесса из указанного хранилища.
(Определяется KrProcessSharedExtensions)
GetKrProcessLaunchResult Возвращает объект содержащий результат запуска процесса или значение по умолчанию для типа, если указанный объект его не содержит.
(Определяется KrProcessSharedExtensions)
GetLocalTiles Получает из указанного объекта коллекцию объектов содержащих информацию о локальных тайлах маршрутов.
(Определяется KrProcessSharedExtensions)
GetRecalcChanges Возвращает информацию о различиях в маршруте до и после пересчёта.
(Определяется KrProcessSharedExtensions)
GetRecalcFlag Возвращает значение, показывающее, должен ли быть выполнен пересчёт маршрута или нет.
(Определяется KrProcessSharedExtensions)
GetStartingSecondaryProcess Возвращает из объекта содержащего дополнительную информацию, информацию необходимую для запуска процесса.
(Определяется KrProcessSharedExtensions)
IgnoreButtons Устанавливает значение, показывающее, что при загрузке карточки не надо добавлять в ответ информацию по тайлам вторичных процессов.
(Определяется KrProcessSharedExtensions)
IgnoreKrSatellite Устанавливает значение, показывающее, что при загрузке карточки не надо загружать и обрабатывать информацию содержащуюся в основном сателлите (KrSatelliteTypeID) карточки.
(Определяется KrProcessSharedExtensions)
Invoke
(Определяется ComHelper)
IsKrSatelliteIgnored Возвращает значение, показывающее, что при загрузке карточки не надо загружать и обрабатывать информацию содержащуюся в основном сателлите (KrSatelliteTypeID) карточки.
(Определяется KrProcessSharedExtensions)
RemoveLocalTiles Удаляет из заданного хранилища информацию по локальным тайлам маршрутов.
(Определяется KrProcessSharedExtensions)
RemoveSecondaryProcess Удаляет из объекта содержащего дополнительную информацию, информацию необходимую для запуска процесса добавленную SetStartingSecondaryProcess(CardInfoStorageObject, StartingSecondaryProcessInfo).
(Определяется KrProcessSharedExtensions)
Set
(Определяется ComHelper)
SetDigest Устанавливает Digest для сохранения в историю действий с карточкой.
(Определяется CardRequestExtensions)
SetForceTaskPanel
(Определяется CardRequestExtensions)
SetHasRecalcChanges Задаёт значение, показывающее, что после пересчёта были изменения в маршруте или нет. Информация добавляется только при выставленном флаге HasChangesToInfo.
(Определяется KrProcessSharedExtensions)
SetIgnorePermissionsWarning Устанавливает признак того, что при обработке карточки могут быть не указаны токены безопасности, поэтому не следует показывать соответствующее предупреждение.
(Определяется CardRequestExtensions)
SetInfoAboutChanges Устанавливает в хранилище информацию о режиме информирования об изменениях в маршруте после пересчёта.
(Определяется KrProcessSharedExtensions)
SetKrProcessInstance Сохраняет в указанном объекте информация об экземпляре процесса.
(Определяется KrProcessSharedExtensions)
SetKrProcessLaunchResult Сохраняет результаты запуска процесса в указанном хранилище.
(Определяется KrProcessSharedExtensions)
SetLocalTiles Сохраняет в указанном объекте коллекцию объектов содержащих информацию о локальных тайлах маршрутов.
(Определяется KrProcessSharedExtensions)
SetPluginType Устанавливает тип плагина при выполнении запроса к карточке из плагина Chronos. Стандартные типы перечислены в CardPluginTypes.
(Определяется CardRequestExtensions)
SetRecalcChanges Сохраняет в заданном хранилище информацию о различиях в маршруте до и после пересчёта.
(Определяется KrProcessSharedExtensions)
SetRecalcFlag Задаёт значение, показывающее, что должен быть выполнен пересчёт маршрута.
(Определяется KrProcessSharedExtensions)
SetStartingKrProcessParameters Устанавливает параметры запускаемого процесса.
(Определяется KrProcessSharedExtensions)
SetStartingSecondaryProcess Устанавливает информацию о процессе, запускаемого посредством WorkflowStoreExtension.
(Определяется KrProcessSharedExtensions)
TryGetDigest Возвращает Digest для сохранения в историю действий с карточкой или null, если Digest не был установлен.
(Определяется CardRequestExtensions)
TryGetKrProcessClientCommands Возвращает из указанного хранилища список клиентских команд или значение по умолчанию для типа, если оно их не содержало.
(Определяется KrProcessSharedExtensions)
TryGetKrProcessInstance Возвращает информацию об экземпляре процесса из указанного хранилища.
(Определяется KrProcessSharedExtensions)
TryGetKrProcessLaunchResult Возвращает объект, содержащий результат запуска процесса.
(Определяется KrProcessSharedExtensions)
TryGetLocalTiles Получает из указанного объекта коллекцию объектов содержащих информацию о локальных тайлах маршрутов.
(Определяется KrProcessSharedExtensions)
TryGetPluginType Возвращает тип плагина, установленный при выполнении запроса к карточке из плагина Chronos, или null, если запрос выполнен не из плагина или из неизвестного плагина.
(Определяется CardRequestExtensions)
TryGetStartingKrProcessParameters Возвращает параметры запускаемого процесса.
(Определяется KrProcessSharedExtensions)

См. также