Для изменения размера нажмите или перетащите

CardFile - класс

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

Пространство имён:  Tessa.Cards
Сборка:  Tessa (в Tessa.dll) Версия: 3.5.0.19
Синтаксис
[SerializableAttribute]
public sealed class CardFile : 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 или пустой строке, если настройки не заданы.
Открытое свойство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.)
Открытый метод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.

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

(Унаследован от 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.)
Открытый метод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).)
В начало страницы
События
  ИмяОписание
Открытое событиеStateChanged
Событие, возникающее при изменении состояния файла State.
В начало страницы
Методы расширения
  ИмяОписание
Открытый метод расширения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.)
В начало страницы
См. также