CardFile - методы |
Тип CardFile предоставляет следующие члены.
Имя | Описание | |
---|---|---|
AddNewVersionTag |
Добавляет заданный тег в список тегов, соответствующих новой версии файла NewVersionTags.
Возвращает признак того, что тег отсутствовал и был добавлен.
| |
Clean | Выполняет очистку хранилища от избыточных данных. (Переопределяет CardInfoStorageObjectClean.) | |
CleanCollectionAndSetNullIfEmpty |
Очищает коллекцию, найденную по ключу key, после чего устанавливает null
на место коллекции, если она стала пустой.
(Унаследован от StorageObject.) | |
ClearCache |
Очищает внутренний кэш декораторов.
(Унаследован от StorageObject.) | |
ContainsKey |
Возвращает признак того, что элемент с заданным ключом содержится в хранилище.
(Унаследован от StorageObject.) | |
DeserializeOptions |
Десериализует настройки Options. Возвращаемый объект не равен null.
Если настройки не заданы, то возвращается пустой объект.
| |
EnsureCacheResolved |
Инициализирует объект-обёртку для всех значений, в т.ч. для вложенных объектов.
Рекомендуется выполнять при создании заполненного объекта перед асинхронным обращением к его вложенным объектам.
(Переопределяет CardInfoStorageObjectEnsureCacheResolved.) | |
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.) | |
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.
(Унаследован от StorageObject.) | |
GetDictionaryT |
Возвращает декоратор для коллекции пар ключ / значение, полученный из хранилища
по заданному ключу или созданный посредством заданной фабрики defaultDictionaryFunc,
и добавленный в хранилище, если он там отсутствует.
(Унаследован от StorageObject.) | |
GetHashCode | Serves as the default hash function. (Унаследован от Object.) | |
GetListT |
Возвращает декоратор для коллекции объектов, полученный из хранилища
по заданному ключу или созданный посредством заданной фабрики defaultListFunc,
и добавленный в хранилище, если он там отсутствует.
(Унаследован от StorageObject.) | |
GetObjectData |
Записывает сериализованные данные текущего объекта в указанный
объект [System.Runtime.Serialization.SerializationInfo].
(Унаследован от StorageObject.) | |
GetStorage |
Возвращает хранилище Dictionary<string, object>,
декоратором для которого является текущий объект.
(Унаследован от StorageObject.) | |
GetType | Gets the Type of the current instance. (Унаследован от Object.) | |
HasChanges |
Возвращает признак того, что карточка файла содержит изменённые значения.
| |
HasNewVersionTag |
Возвращает признак того, что создаваемая версия будет содержать указанный тег в свойстве NewVersionTags.
| |
HasPendingStateChanges |
Возвращает признак того, что во флагах Flags установлены флаги,
влияющие на смену состояния на изменённое.
| |
HasSize |
Возвращает признак того, что файл содержит информацию о длине контента файла,
т.е. свойство Size отлично от значения -1.
| |
Init |
Инициализирует значение объекта с заданным ключом, если он отсутствовал в хранилище.
(Унаследован от StorageObject.) | |
InitNotNull |
Инициализирует значение объекта с заданным ключом, если он отсутствовал в хранилище или был равен null,
посредством фабрики объектов.
(Унаследован от StorageObject.) | |
InvalidateLastVersion |
Сбрасывает значение свойства LastVersion, т.к. оно устарело в связи с изменениями в версиях файла.
Значение будет вновь установлено при первом обращении к свойству.
| |
IsValid | Выполняет проверку объекта на валидность и возвращает признак того, что объект является валидным. (Унаследован от ValidationStorageObject.) | |
MemberwiseClone | Creates 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.) | |
RemoveChanges |
Выполняет удаление информации по состояниям, из которой можно было бы определить,
что файл изменён. Возвращает признак того, что при этом были внесены изменения.
| |
RemoveNewVersionTag |
Удаляет заданный тег из списка тегов, соответствующих новой версии файла NewVersionTags.
Возвращает признак того, что тег присутствовал и был удалён.
| |
RemoveSystemInfo | Удаляет системную информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом SystemKeyPrefix. Внимание! После выполнения метода из карточки исчезнут важные сведения, такие как информация об изменённых полях или о состоянии строк коллекционных и древовидных секций. | |
RemoveUserInfo |
Удаляет пользовательскую информацию, которая может располагаться в любом месте в хранилище текущего объекта
и может быть найдена по ключам с префиксом UserKeyPrefix.
(Унаследован от CardInfoStorageObject.) | |
RepairStorageAsync |
Исправляет хранилище объекта, типы в котором установлены некорректно, после десериализации из JSON.
Возвращает признак того, что при исправлении в объекте были изменения.
| |
ResetSize |
Устанавливает признак того, что файл не содержит информацию о длине контента файла,
т.е. свойство Size устанавливается как -1.
| |
RevertReplacedState |
Устанавливает состояние None, если файл был в состоянии Replaced.
Устанавливает состояние Modified, если файл был в состоянии ModifiedAndReplaced.
В других случаях не выполняет действий.
Возвращает WasReplaced, если состояние было изменено,
и WasIncompatible.
| |
SetT |
Устанавливает значение в хранилище по заданному ключу.
При этом не изменяется внутренний кэш декораторов, поэтому метод следует использовать
только для примитивных типов.
(Унаследован от StorageObject.) | |
SetCard |
Связывает данные текущего объекта с заданной карточкой файла.
При это устанавливаются свойства RowID, TypeID, TypeName,
TypeCaption и Card.
| |
SetNull |
Устанавливает значение null для элемента по заданному ключу и
удаляет предыдущий элемент из внутреннего кэша декораторов.
(Унаследован от StorageObject.) | |
SetNullIfEmptyEnumerable | (Унаследован от StorageObject.) | |
SetReplacedState |
Устанавливает состояние Replaced, если файл был в состоянии None.
Устанавливает состояние ModifiedAndReplaced, если файл был в состоянии Modified.
В других случаях не выполняет действий.
| |
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.) | |
ToString | Returns a string that represents the current object. (Унаследован от Object.) | |
ToTypedJson |
Сериализует объект в текстовый JSON с сохранением информации по типам для всех подобъектов, в т.ч. для Info.
Используйте метод FromTypedJson для десериализации.
Для сериализации других объектов, у которых нет метода ToTypedJson (например, request/response),
используйте метод SerializeToTypedJson(DictionaryString, Object, Boolean),
передав в него структуру объекта obj.GetStorage().
(Унаследован от StorageObject.) | |
TryGetT |
Возвращает строго типизированное значение объекта из хранилища по заданному ключу
или default(T), если объект по заданному ключу не найден.
(Унаследован от StorageObject.) | |
TryGetCard |
Возвращает карточку файла
или null, если карточка ещё не была задана.
| |
TryGetDictionaryT |
Возвращает строго типизированное значение объекта Dictionary<string, object>
из хранилища по заданному ключу или default(T),
если объект по заданному ключу не найден.
(Унаследован от StorageObject.) | |
TryGetInfo |
Возвращает дополнительную пользовательскую информацию по текущему объекту
или null, если информация ещё не была задана.
(Унаследован от CardInfoStorageObject.) | |
TryGetListT |
Возвращает строго типизированное значение объекта List<object>
из хранилища по заданному ключу или default(T),
если объект по заданному ключу не найден.
(Унаследован от StorageObject.) | |
TryGetRequestInfo |
Возвращает дополнительную пользовательскую информацию по текущему объекту, передаваемую в запросы
CardGetFileContentRequest и CardGetFileVersionsRequest,
и в запрос на загрузку списка подписей GetVersionSignatures,
или null, если информация ещё не была задана.
| |
TryGetSectionRows |
Возвращает пустые строки для коллекционных и древовидных секций, доступные по имени секции,
или null, если строки ещё не были заданы.
| |
TryGetString |
Возвращает строковое представление для значения объекта из хранилища по заданному ключу
или null, если объект по заданному ключу не найден.
(Унаследован от StorageObject.) | |
TryGetVersions |
Возвращает список версий файла
или null, если список версий файла ещё не был задан или не был загружен.
| |
UpdateState |
Обновляет состояние файла State
в зависимости от наличия изменений во флагах или в данных карточки файла.
| |
Validate |
Выполняет валидацию объекта и всех его дочерних объектов.
(Унаследован от ValidationStorageObject.) | |
Validate(IValidationResultBuilder) | Выполняет валидацию текущего объекта и всех его дочерних объектов. (Унаследован от ValidationStorageObject.) | |
ValidateInternal | Выполняет валидацию текущего объекта и всех его дочерних объектов. (Переопределяет CardInfoStorageObjectValidateInternal(IValidationResultBuilder).) |
Имя | Описание | |
---|---|---|
AddKrProcessClientCommands | (Определяется KrProcessSharedExtensions.) | |
AreButtonsIgnored | (Определяется KrProcessSharedExtensions.) | |
ConsiderHiddenStages | (Определяется KrProcessSharedExtensions.) | |
ConsiderSkippedStages | (Определяется KrProcessSharedExtensions.) | |
DontHideStages | (Определяется KrProcessSharedExtensions.) | |
Get | (Определяется ComHelper.) | |
GetHasRecalcChanges | (Определяется KrProcessSharedExtensions.) | |
GetIgnoreExternalSourceContent |
Возвращает признак того, что при сохранении карточки могут быть не указаны токены безопасности,
поэтому не следует показывать соответствующее предупреждение.
Если признак не был установлен, то возвращается false.
(Определяется CardRequestExtensions.) | |
GetIgnorePermissionsWarning |
Возвращает признак того, что при сохранении карточки могут быть не указаны токены безопасности,
поэтому не следует показывать соответствующее предупреждение.
Если признак не был установлен, то возвращается false.
(Определяется CardRequestExtensions.) | |
GetInfoAboutChanges | (Определяется KrProcessSharedExtensions.) | |
GetKrProcessClientCommands | (Определяется KrProcessSharedExtensions.) | |
GetKrProcessInstance | (Определяется KrProcessSharedExtensions.) | |
GetKrProcessLaunchResult | (Определяется KrProcessSharedExtensions.) | |
GetLocalTiles | (Определяется KrProcessSharedExtensions.) | |
GetRecalcChanges | (Определяется KrProcessSharedExtensions.) | |
GetRecalcFlag | (Определяется KrProcessSharedExtensions.) | |
GetStartingSecondaryProcess | (Определяется KrProcessSharedExtensions.) | |
IgnoreButtons | (Определяется KrProcessSharedExtensions.) | |
IgnoreKrSatellite | (Определяется KrProcessSharedExtensions.) | |
InternalMarkerCanvas |
Возвращает маркер аннотации
(Определяется AnnotationInternalsAccessor.) | |
Invoke | (Определяется ComHelper.) | |
IsKrSatelliteIgnored | (Определяется KrProcessSharedExtensions.) | |
RemoveLocalTiles | (Определяется KrProcessSharedExtensions.) | |
RemoveSecondaryProcess | (Определяется KrProcessSharedExtensions.) | |
Set | (Определяется ComHelper.) | |
SetDigest |
Устанавливает Digest для сохранения в историю действий с карточкой.
(Определяется CardRequestExtensions.) | |
SetForceTaskPanel | (Определяется CardRequestExtensions.) | |
SetHasRecalcChanges | (Определяется KrProcessSharedExtensions.) | |
SetIgnoreExternalSourceContent |
Устанавливает признак того, что при обработке файла системой не следует учитывать свойство ExternalSource
как необходимость копировать контент файла. Например, при создании шаблона контент копируется средствами расширения
и не должен копироваться системой.
(Определяется CardRequestExtensions.) | |
SetIgnorePermissionsWarning |
Устанавливает признак того, что при обработке карточки могут быть не указаны токены безопасности,
поэтому не следует показывать соответствующее предупреждение.
(Определяется CardRequestExtensions.) | |
SetInfoAboutChanges | (Определяется KrProcessSharedExtensions.) | |
SetKrProcessInstance | (Определяется KrProcessSharedExtensions.) | |
SetKrProcessLaunchResult | (Определяется KrProcessSharedExtensions.) | |
SetLocalTiles | (Определяется KrProcessSharedExtensions.) | |
SetPluginType |
Устанавливает тип плагина при выполнении запроса к карточке из плагина Chronos.
Стандартные типы перечислены в CardPluginTypes.
(Определяется CardRequestExtensions.) | |
SetRecalcChanges | (Определяется KrProcessSharedExtensions.) | |
SetRecalcFlag | (Определяется KrProcessSharedExtensions.) | |
SetStartingSecondaryProcess | (Определяется KrProcessSharedExtensions.) | |
ToMailFile | (Определяется NoticesExtensions.) | |
TryGetDigest |
Возвращает Digest для сохранения в историю действий с карточкой
или null, если Digest не был установлен.
(Определяется CardRequestExtensions.) | |
TryGetKrProcessClientCommands | (Определяется KrProcessSharedExtensions.) | |
TryGetKrProcessInstance | (Определяется KrProcessSharedExtensions.) | |
TryGetKrProcessLaunchResult | (Определяется KrProcessSharedExtensions.) | |
TryGetLocalTiles | (Определяется KrProcessSharedExtensions.) | |
TryGetPluginType |
Возвращает тип плагина, установленный при выполнении запроса к карточке из плагина Chronos,
или null, если запрос выполнен не из плагина или из неизвестного плагина.
(Определяется CardRequestExtensions.) |