CardHelper - методы |
Тип CardHelper предоставляет следующие члены.
Методы| Имя | Описание | |
|---|---|---|
  | Compress |
Выполняет упаковку пакета карточки. Заданный декоратор становится непригоден к использованию.
|
| CompressFileVersions |
Выполняет упаковку запроса на получение информации по версиям файла. Заданный декоратор становится непригоден к использованию.
|
| CopyFilesAsync | Создаёт копии файлов карточки sourceCard в карточке targetCard. При этом не выполняется расширений, но учитываются все те же особенности, что и при создании карточек по шаблону. Подписи файла по умолчанию не переносятся, если не указан параметр copySignatures. Фактическая копия файла с контентом будет создана после сохранения карточки targetCard. Метод может вызываться как на сервере, так и на клиенте (причём сервер не будет вызван). Метод возвращает результат копирования, который не равен null и содержит ошибки, если копирование не было выполнено. Т.к. в карточке targetCard могут быть добавлены файлы, то карточку рекомендуется сохранять посредством ICardFileManager, чтобы содержимое файлов было корректно скопировано. При сохранении посредством ICardRepository файлы будут добавлены без содержимого. |
| CreateDefaultFileType |
Создаёт тип карточки CardType, описывающий стандартный тип файла FileTypeID.
Рекомендуется использовать только в целях предпросмотра карточек.
|
| CreateDeletedAfterBeginTransactionAsync |
Метод, создающий карточку в корзине. Обычно вызывается в AfterBeginTransaction(ICardDeleteExtensionContext)
до того, как карточка будет удалена, но уже внутри транзакции.
Вызывается как в платформенной расширении на удаление в корзину,
также может быть вызван для удаления в корзину виртуальных карточек.
Возвращает признак того, что удалённая карточка была создана.
|
| CreateDeletedAfterRequestAsync |
Метод, выполняемый после создания карточки в корзине CreateDeletedAfterBeginTransactionAsync(ICardDeleteExtensionContext, ICardContentStrategy, ICardStoreStrategy, ICardRepository, ICardRepository, ICardRepository, ICardRepository, CancellationToken)
снаружи транзакции. Обычно вызывается в AfterBeginTransaction(ICardDeleteExtensionContext),
после того, как карточка будет удалена, но уже внутри транзакции.
Вызывается как в платформенной расширении на удаление в корзину,
также может быть вызван для удаления в корзину виртуальных карточек.
|
| CreateFromExportedCardAsync |
Создаёт карточку по экспортированной карточке и информации из карточки-источника,
из которой выполнялся экспорт и которая используется для связи с файлами.
|
| CreateFromTemplateAsync |
Создаёт карточку по шаблону и возвращает её.
|
| CreateSectionRows |
Создаёт объект, содержащий коллекцию пустых строк коллекционных и древовидных секций,
упорядоченных по имени секции.
|
| Decompress(DictionaryString, Object) |
Выполняет распаковку пакета карточки.
|
| Decompress(IStorageObjectProvider) |
Выполняет распаковку пакета карточки.
|
| DecompressFileVersions(DictionaryString, Object) |
Выполняет распаковку запроса на получение информации по версиям файла.
|
| DecompressFileVersions(IStorageObjectProvider) |
Выполняет распаковку запроса на получение информации по версиям файла.
|
| ExecuteTypeExtensionsAsync |
Выполняет расширения на типы карточек для заданного типа расширений type.
|
| GetBlockClass |
Возвращает имя класса блока, используемое в типах карточек.
|
| GetCardFileNameWithoutExtension |
Возвращает корректное имя файла карточки без расширения по дайджесту карточки.
Может использоваться для определения имени файла для экспортируемой карточки.
|
| GetCardFileTypes | |
| GetDisplayText |
Возвращает текст для отображения, в котором был заменён перевод строки.
|
| GetFileCardTypesAsync |
Получение типов файлов, доступных из API карточек.
|
| GetFormClass |
Возвращает имя класса формы, используемое в типах карточек.
|
| GetLink |
Возвращает ссылку на открытие карточки в клиентском приложении с опциональным открытием файла в карточке.
|
| GetTaskState |
Возвращает строку с кратким описанием по состоянию задания по его параметрам.
|
| GetTaskStateDate |
Возвращает дату, актуальную для состояния задания.
Состояние можно получить вызовом метода GetTaskState(String, String, NullableGuid).
|
| GetWebFileLink | |
| GetWebLink |
Возвращает ссылку на открытие карточки в web-клиенте
или null, если ссылка webAddress является равна null после нормализации.
|
| GrantAllPermissions |
Выдаёт все возможные разрешения для заданной карточки и её вложенных карточек.
|
| HasFilesContentsToSave |
Возвращает признак того, что в заданной карточке присутствует хотя бы один файл,
который был добавлен или содержимое которого было изменено.
|
| IsSystemKey |
Определяет, является ли заданный ключ хранилища IDictionary<string, object> системным ключом.
|
| IsUserKey |
Определяет, является ли заданный ключ хранилища IDictionary<string, object> пользовательским ключом.
|
| LimitDisplayValue |
Ограничивает длину имени карточки для отображения пользователю или в ссылке на карточку.
|
| MergeSection | |
| ProhibitAllPermissions |
Явно запрещает все возможные разрешения для заданной карточки и её вложенных карточек.
|
| SetAllCardPermissions |
Устанавливает указанные разрешения для карточки, её файлов и заданий.
|
| StoreAsync(CardStoreRequest, IFileContainer, ICardRepository, ICardStreamServerRepository, CancellationToken) |
Выполняет сохранение карточки на сервере с возможным наличием файлов.
Не выполняет проверку на наличие изменений в контенте файлов методом
EnsureAllContentModifiedAsync(IEnumerableIFile, CancellationToken).
Метод для внутреннего использования, рекомендуется использовать объект ICardFileManager
для сохранения карточки с файлами, обратитесь к руководству разработчика за примерами.
|
| StoreAsync(CardStoreRequest, IFileContainer, ICardRepository, ICardStreamClientRepository, FuncDouble, CancellationToken, ValueTask, Int32, CancellationToken) |
Выполняет асинхронное сохранение карточки на клиенте с возможным наличием файлов.
Не выполняет проверку на наличие изменений в контенте файлов.
Метод для внутреннего использования, рекомендуется использовать объект ICardFileManager
для сохранения карточки с файлами, обратитесь к руководству разработчика за примерами.
|
| TemplateFileIsMatchForSource(CardFile, Guid) |
Возвращает признак того, что заданный файл, расположенный в шаблоне,
соответствует файлу в карточке с заданным идентификатором. Идентификатор версии не проверяется.
|
| TemplateFileIsMatchForSource(CardFile, Guid, Guid) |
Возвращает признак того, что заданный файл, расположенный в шаблоне,
соответствует файлу в карточке с заданным идентификатором и идентификатором версии.
|
| TryGetCsvEncodingAsync |
Возвращает кодировку для формирования файлов csv
|
| TryGetCsvSeparatorAsync |
Возвращает разделитель для формирования файлов csv. В случае если символ не задан
или при конвертации символа произошла ошибка возвращает ';' в качестве разделителя
по умолчанию
|
| TryGetWebAddressAsync |
Возвращает базовый адрес веб-клиента
или null, если адрес не удалось получить.
|
| TryParseCardFileFormatFromExtension |
Определяет формат файла по расширению. Возвращает null, если определить формат не удалось.
|
| TryParseLink |
Выполняет попытку прочитать параметры, полученные для открытия карточки по ссылке.
|
См. также