CardSection - класс

Содержит данные строковой, коллекционной или древовидной секции карточки.

Definition

Пространство имён: Tessa.Cards
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4
C#
[StorageObjectGeneratorAttribute(GenerateDefaultConstructor = false)]
public sealed class CardSection : CardStorageObject, 
	ICardFieldContainer, ICloneable, IStorageNotificationReceiver, IStorageObjectStateProvider
Inheritance
Object    StorageObject    ValidationStorageObject    CardStorageObject    CardSection
Implements
ICloneable, ICardFieldContainer, IStorageNotificationReceiver, IStorageObjectStateProvider

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

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

Свойства

Fields Значения полей для строковой секции с поддержкой состояний. При изменении значений любого поля через это свойство такое поле помечается как изменённое. Если секция является коллекционной или древовидной, то при этом вызывается исключение NotSupportedException.
Name Название секции.
RawFields Значения полей для строковой секции или null, если секция является коллекционной или древовидной.
Rows Строки и их значения для коллекционной и древовидной секций. Если секция является строковой, возникнет исключение.
RowSortingType Тип сортировки строк для коллекционной или древовидной секции.
StateRows Доступный только для чтения список значений полей для строк коллекционных и древовидных секций с поддержкой состояний. При изменении значений любого поля некоторой строки через это свойство такое поле и строка помечаются как изменённые. Если секция является строковой, то вызывается исключение NotSupportedException.
TableType Тип коллекционной или древовидной секции. Для строковой секции всегда возвращается значение Unspecified.
Type Тип секции карточки. Не содержится в пакете и вычисляется на основании наличия в пакете определённых полей.

Методы

CleanВыполняет очистку хранилища от избыточных данных.
(Переопределяет CardStorageObjectClean)
CleanCollectionAndSetNullIfEmpty Очищает коллекцию, найденную по ключу key, после чего устанавливает null на место коллекции, если она стала пустой.
(Унаследован от StorageObject)
ClearCache Очищает внутренний кэш декораторов.
(Унаследован от StorageObject)
ClearChangesУдаляет всю информацию об изменённых объектах.
Clone Выполняет глубокое клонирование хранилища объекта и возвращает созданный строго типизированный декоратор для хранилища.
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)
GetAllChangesВозвращает коллекцию ключей всех объектов, значения которых были изменены.
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)
HasChangesВозвращает признак того, что объект содержит изменённые значения.
Init Инициализирует значение объекта с заданным ключом, если он отсутствовал в хранилище.
(Унаследован от StorageObject)
InitNotNull Инициализирует значение объекта с заданным ключом, если он отсутствовал в хранилище или был равен null, посредством фабрики объектов.
(Унаследован от StorageObject)
IsChanged Возвращает признак того, что значение объекта с ключом key было изменено.
IsEmpty Возвращает признак того, что объект не содержит значимых данных для метода очистки [Tessa.Platform.Storage.IStorageCleanable.Clean].
IsValidВыполняет проверку объекта на валидность и возвращает признак того, что объект является валидным.
(Унаследован от ValidationStorageObject)
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
NotifyFieldChangedУведомляет подписчиков событий о том, что изменилось поле.
NotifyStorageUpdatedМетод, уведомляющий объект о наличии изменений в его хранилище.
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)
RemoveAllButChanged Удаляет информацию о всех полях или строках секции, которые не были изменены посредством IStorageObjectStateProvider.
RemoveChanges Выполняет удаление информации по состояниям, из которой можно было бы определить, что секция изменена. Возвращает признак того, что при этом были внесены изменения.
RepairStorage Исправляет хранилище объекта, типы в котором установлены некорректно, после десериализации из JSON. Возвращает признак того, что при исправлении в объекте были изменения.
Set(CardSection) Устанавливает состояние текущего объекта идентичным состоянию заданной секции. При этом копируется заданная секция со всеми её данными.
Set(String, Object) Устанавливает значение в хранилище по заданному ключу. При этом не изменяется внутренний кэш декораторов, поэтому метод следует использовать только для примитивных типов.
(Унаследован от StorageObject)
SetChanged Устанавливает признак isChanged, определяющий, было ли изменено значение объекта с ключом key.
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)
TryGetListT Возвращает строго типизированное значение объекта List<object> из хранилища по заданному ключу или default(T), если объект по заданному ключу не найден.
(Унаследован от StorageObject)
TryGetRawFields Возвращает значения полей для строковой секции или null, если значения ещё не были заданы или секция не является строковой.
TryGetRows Возвращает коллекцию строк для коллекционной или древовидной секции или null, если коллекция ещё не была создана или секция не является коллекционной или древовидной.
TryGetRowSortingType Возвращает тип сортировки строк для коллекционной или древовидной секции. или null, если значение ещё не было задано или секция не является коллекционной или древовидной.
TryGetString Возвращает строковое представление для значения объекта из хранилища по заданному ключу или null, если объект по заданному ключу не найден.
(Унаследован от StorageObject)
Validate Выполняет валидацию объекта и всех его дочерних объектов.
(Унаследован от ValidationStorageObject)
Validate(IValidationResultBuilder)Выполняет валидацию текущего объекта и всех его дочерних объектов.
(Унаследован от ValidationStorageObject)
ValidateInternalВыполняет валидацию текущего объекта и всех его дочерних объектов.
(Переопределяет ValidationStorageObjectValidateInternal(IValidationResultBuilder))

События

FieldChangedЗначение поля было изменено, причём валидация уже была выполнена.

Поля

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

Get
(Определяется ComHelper)
Invoke
(Определяется ComHelper)
Set
(Определяется ComHelper)
TryGetFieldIgnoreCaseAsyncT Возвращает значение поля строковой секции или строки коллекционной секции карточки без учёта регистра или null, если такое поле отсутствует.
(Определяется CardExtensions)
TrySetFieldIgnoreCaseAsync Устанавливает значение поля строковой секции или строки коллекционной секции карточки без учёта регистра. Возвращает признак того, что значение было установлено, т.к. было определено имя поля с учётом регистра.
(Определяется CardExtensions)

См. также