CardFile - класс

Общая информация о файле, прикреплённом к карточке.

Definition

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

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

CardFile Создаёт экземпляр класса и пустое хранилище Dictionary<string, object>, декоратором для которого является создаваемый объект.
CardFile(DictionaryString, Object)Создаёт экземпляр класса с указанием хранилища, декоратором для которого является создаваемый объект.
CardFile(IStorageObjectProvider) Создаёт экземпляр класса с указанием объекта, предоставляющего доступ к хранилищу, декоратором для которого является создаваемый объект.

Свойства

Card Карточка файла.
CategoryCaption Отображаемое имя категории файла или null, если категория файла не указана.
CategoryID Идентификатор категории файла или null, если категория файла не указана или выбранная категория не имеет идентификатора. Значение CategoryCaption обязательно должно быть указано для того, чтобы файл был включён в категорию, а значение CategoryID является опциональным для идентификации категории.
Dynamic Объект, осуществляющий доступ к текущему объекту через позднее связывание свойств.
(Унаследован от CardInfoStorageObject)
DynamicInfo Объект, осуществляющий доступ к дополнительной пользовательской информации по текущему объекту через позднее связывание свойств.
(Унаследован от CardInfoStorageObject)
ExternalSource Внешний источник контента для файла или null, если внешний источник отсутствует и контент для файла загружается стандартным образом.
Flags Флаги файла.
Hash Хеш контента для последней версии файла или null, если хеш не указан. Рекомендуется указать при создании новой версии, чтобы в дальнейшем для этой версии был доступен хеш контента. Укажите флаг CalculateHash в свойстве Flags для того, чтобы при сохранении файла хеш-сумма была вычислена на сервере, независимо от значения в свойстве Hash. По умолчанию значение равно null, при этом для новых версий хеш считается не заданным.
Info Дополнительная пользовательская информация.
(Унаследован от CardInfoStorageObject)
IsVirtual Признак того, что файл виртуальный, такой как "Лист согласования". Некоторые расширения учитывают этот признак, и, например, игнорируют файл при назначении разрешений в процессе чтения карточки.
LastVersion Последняя версия файла или null, если последняя версия неизвестна.
Name Имя файла.
NewVersionTags Теги новой версии файла, если такая версия будет создана в процессе сохранения. Могут быть равны null или пустой строке, если теги не заданы, или если файл не подготовлен для сохранения.
Options Сериализованные в типизированный JSON настройки файла. Могут быть равны null или пустой строке, если настройки не заданы. Для установки значения рекомендуется использовать метод SetOptions(DictionaryString, Object), а для получения - DeserializeOptions.
OriginalFileID Идентификатор файла, копией версии которого является текущий файл, или null, если файл является оригиналом, а не копией.
OriginalVersionRowID Идентификатор версии файла, копией которой является текущий файл, или null, если файл является оригиналом, а не копией.
RequestInfo Дополнительная пользовательская информация, передаваемая в запросы CardGetFileContentRequest и CardGetFileVersionsRequest, и в запрос на загрузку списка подписей GetVersionSignatures.
RowID Идентификатор строки с описанием файла.
SectionRows Пустые строки коллекционных и древовидных секций, доступные по имени секции. Могут использоваться для редактирования карточки файла.
Size Размер контента последней версии файла в байтах или -1, если размер неизвестен или не был задан. В серверных расширениях на сохранение это свойство можно использовать для определения размера контента сохраняемых файлов.
State Состояние файла.
StoreSource Местоположение, которое следует использовать для сохраняемого контента файла. Актуально только для файла, для которого создаётся новая версия. По умолчанию значение равно Database.
TaskID Идентификатор задания, к которому приложен файл, или null, если файл приложен к основной карточке.
TypeCaption Отображаемое имя типа файла.
TypeID Идентификатор типа файла.
TypeName Имя типа файла.
VersionNumber Актуальная версия файла.
VersionRowID Идентификатор актуальной версии файла.
Versions Список версий файла. Загружается отложенно; список заполнен, если значение VersionsLoaded равно true.
VersionsLoaded Признак того, что список версий Versions был загружен.

Методы

AddNewVersionTag Добавляет заданный тег в список тегов, соответствующих новой версии файла NewVersionTags. Возвращает признак того, что тег отсутствовал и был добавлен.
CleanВыполняет очистку хранилища от избыточных данных.
(Переопределяет CardInfoStorageObjectClean)
CleanCollectionAndSetNullIfEmpty Очищает коллекцию, найденную по ключу key, после чего устанавливает null на место коллекции, если она стала пустой.
(Унаследован от StorageObject)
ClearCache Очищает внутренний кэш декораторов.
(Унаследован от StorageObject)
ContainsKey Возвращает признак того, что элемент с заданным ключом содержится в хранилище.
(Унаследован от StorageObject)
DeserializeOptions Десериализует настройки Options. Возвращаемый объект не равен null. Если настройки не заданы, то возвращается пустой объект.
EnsureCacheResolved Инициализирует объект-обёртку для всех значений, в т.ч. для вложенных объектов. Рекомендуется выполнять при создании заполненного объекта перед асинхронным обращением к его вложенным объектам.
(Переопределяет CardInfoStorageObjectEnsureCacheResolved)
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.
(Унаследован от StorageObject)
GetDictionaryT Возвращает декоратор для коллекции пар ключ / значение, полученный из хранилища по заданному ключу или созданный посредством заданной фабрики defaultDictionaryFunc, и добавленный в хранилище, если он там отсутствует.
(Унаследован от StorageObject)
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetListT Возвращает декоратор для коллекции объектов, полученный из хранилища по заданному ключу или созданный посредством заданной фабрики defaultListFunc, и добавленный в хранилище, если он там отсутствует.
(Унаследован от StorageObject)
GetObjectData Записывает сериализованные данные текущего объекта в указанный объект [System.Runtime.Serialization.SerializationInfo].
(Унаследован от StorageObject)
GetStorage Возвращает хранилище Dictionary<string, object>, декоратором для которого является текущий объект.
(Унаследован от StorageObject)
GetTypeGets the Type of the current instance.
(Унаследован от Object)
HasChanges Возвращает признак того, что карточка файла содержит изменённые значения.
HasNewVersionTag Возвращает признак того, что создаваемая версия будет содержать указанный тег в свойстве NewVersionTags.
HasPendingStateChanges Возвращает признак того, что во флагах Flags установлены флаги, влияющие на смену состояния на изменённое.
HasSize Возвращает признак того, что файл содержит информацию о длине контента файла, т.е. свойство Size отлично от значения -1.
Init Инициализирует значение объекта с заданным ключом, если он отсутствовал в хранилище.
(Унаследован от StorageObject)
InitNotNull Инициализирует значение объекта с заданным ключом, если он отсутствовал в хранилище или был равен null, посредством фабрики объектов.
(Унаследован от StorageObject)
InvalidateLastVersion Сбрасывает значение свойства LastVersion, т.к. оно устарело в связи с изменениями в версиях файла. Значение будет вновь установлено при первом обращении к свойству.
IsEmpty Возвращает признак того, что объект не содержит значимых данных для метода очистки [Tessa.Platform.Storage.IStorageCleanable.Clean].
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)
RemoveChanges Выполняет удаление информации по состояниям, из которой можно было бы определить, что файл изменён. Возвращает признак того, что при этом были внесены изменения.
RemoveNewVersionTag Удаляет заданный тег из списка тегов, соответствующих новой версии файла NewVersionTags. Возвращает признак того, что тег присутствовал и был удалён.
RemoveSystemInfo

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

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


(Унаследован от CardInfoStorageObject)
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 Устанавливает равным null элемент с ключом key, если он является пустым перечислением IEnumerable.
(Унаследован от StorageObject)
SetOptions Устанавливает значение свойства Options с выполнением сериализации указанного хранилища.
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)
ToStringReturns a string that represents the current object.
(Унаследован от Object)
ToTypedJson Сериализует объект в текстовый JSON с сохранением информации по типам для всех подобъектов, в т.ч. для Info. Используйте метод FromTypedJson для десериализации. Для сериализации других объектов, у которых нет метода ToTypedJson (например, request/response), используйте метод [!:StorageHelper.SerializeToTypedJson(Dictionary<string,object>,bool)], передав в него структуру объекта 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))

События

StateChanged Событие, возникающее при изменении состояния файла State.

Поля

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

AddKrProcessClientCommands Добавляет в указанное хранилище список клиентских команд.
(Определяется KrProcessSharedExtensions)
AreButtonsIgnored Получает из заданного хранилища значение флага показывающего, что при загрузке карточки не надо добавлять в ответ информацию по тайлам вторичных процессов.
(Определяется KrProcessSharedExtensions)
ConsiderHiddenStages Возвращает значение, показывающее, что в карточку должны быть загружены скрытые этапы маршрута.
(Определяется KrProcessSharedExtensions)
ConsiderSkippedStages Возвращает значение из заданного хранилища, показывающее, требуется ли отображать пропущенные этапы.
(Определяется KrProcessSharedExtensions)
DontHideStages Добавляет в указанное хранилище значение, показывающее, необходимо ли загружать в карточку скрытые этапы маршрута или нет.
(Определяется KrProcessSharedExtensions)
Get
(Определяется ComHelper)
GetHasRecalcChanges Возвращает значение, показывающее, что после пересчёта были изменения в маршруте или нет. Информация добавляется только при выставленном флаге HasChangesToInfo.
(Определяется 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 Устанавливает значение, показывающее, что при загрузке карточки не надо загружать и обрабатывать информацию содержащуюся в основном сателлите (KrSatelliteTypeID) карточки.
(Определяется KrProcessSharedExtensions)
InternalMarkerCanvas Возвращает маркер аннотации
(Определяется AnnotationInternalsAccessor)
Invoke
(Определяется ComHelper)
IsKrSatelliteIgnored Возвращает значение, показывающее, что при загрузке карточки не надо загружать и обрабатывать информацию содержащуюся в основном сателлите (KrSatelliteTypeID) карточки.
(Определяется KrProcessSharedExtensions)
RemoveLocalTiles Удаляет из заданного хранилища информацию по локальным тайлам маршрутов.
(Определяется KrProcessSharedExtensions)
RemoveSecondaryProcess Удаляет из объекта содержащего дополнительную информацию, информацию необходимую для запуска процесса добавленную SetStartingSecondaryProcess(CardInfoStorageObject, StartingSecondaryProcessInfo).
(Определяется KrProcessSharedExtensions)
Set
(Определяется ComHelper)
SetDigest Устанавливает Digest для сохранения в историю действий с карточкой.
(Определяется CardRequestExtensions)
SetForceTaskPanel
(Определяется CardRequestExtensions)
SetHasRecalcChanges Задаёт значение, показывающее, что после пересчёта были изменения в маршруте или нет. Информация добавляется только при выставленном флаге HasChangesToInfo.
(Определяется KrProcessSharedExtensions)
SetIgnoreExternalSourceContent Устанавливает признак того, что при обработке файла системой не следует учитывать свойство ExternalSource как необходимость копировать контент файла. Например, при создании шаблона контент копируется средствами расширения и не должен копироваться системой.
(Определяется CardRequestExtensions)
SetIgnorePermissionsWarning Устанавливает признак того, что при обработке карточки могут быть не указаны токены безопасности, поэтому не следует показывать соответствующее предупреждение.
(Определяется CardRequestExtensions)
SetInfoAboutChanges Устанавливает в хранилище информацию о режиме информирования об изменениях в маршруте после пересчёта.
(Определяется KrProcessSharedExtensions)
SetKrProcessInstance Сохраняет в указанном объекте информация об экземпляре процесса.
(Определяется KrProcessSharedExtensions)
SetKrProcessLaunchResult Сохраняет результаты запуска процесса в указанном хранилище.
(Определяется KrProcessSharedExtensions)
SetLocalTiles Сохраняет в указанном объекте коллекцию объектов содержащих информацию о локальных тайлах маршрутов.
(Определяется KrProcessSharedExtensions)
SetPluginType Устанавливает тип плагина при выполнении запроса к карточке из плагина Chronos. Стандартные типы перечислены в CardPluginTypes.
(Определяется CardRequestExtensions)
SetRecalcChanges Сохраняет в заданном хранилище информацию о различиях в маршруте до и после пересчёта.
(Определяется KrProcessSharedExtensions)
SetRecalcFlag Задаёт значение, показывающее, что должен быть выполнен пересчёт маршрута.
(Определяется KrProcessSharedExtensions)
SetStartingKrProcessParameters Устанавливает параметры запускаемого процесса.
(Определяется KrProcessSharedExtensions)
SetStartingSecondaryProcess Устанавливает информацию о процессе, запускаемого посредством WorkflowStoreExtension.
(Определяется KrProcessSharedExtensions)
ToMailFile
(Определяется NoticesExtensions)
TryGetDigest Возвращает Digest для сохранения в историю действий с карточкой или null, если Digest не был установлен.
(Определяется CardRequestExtensions)
TryGetKrProcessClientCommands Возвращает из указанного хранилища список клиентских команд или значение по умолчанию для типа, если оно их не содержало.
(Определяется KrProcessSharedExtensions)
TryGetKrProcessInstance Возвращает информацию об экземпляре процесса из указанного хранилища.
(Определяется KrProcessSharedExtensions)
TryGetKrProcessLaunchResult Возвращает объект, содержащий результат запуска процесса.
(Определяется KrProcessSharedExtensions)
TryGetLocalTiles Получает из указанного объекта коллекцию объектов содержащих информацию о локальных тайлах маршрутов.
(Определяется KrProcessSharedExtensions)
TryGetPluginType Возвращает тип плагина, установленный при выполнении запроса к карточке из плагина Chronos, или null, если запрос выполнен не из плагина или из неизвестного плагина.
(Определяется CardRequestExtensions)
TryGetStartingKrProcessParameters Возвращает параметры запускаемого процесса.
(Определяется KrProcessSharedExtensions)

См. также