public interface IFileConverterRequest : ISealablePublic Interface IFileConverterRequest
Inherits ISealablepublic interface class IFileConverterRequest : ISealabletype IFileConverterRequest =
interface
interface ISealable
end| CardID | Идентификатор карточки с преобразуемым файлом. |
| CardTypeID | Идентификатор типа карточки с преобразуемым файлом, который указывается в запросе на конвертацию CardGetFileContentRequest.CardTypeID, или null, если свойство не указывается в запросе. От значения этого свойства не зависит вычисление хеша запроса (и идентификация похожих операций). Значение необязательно для заполнения, его можно использовать для конвертации виртуальных файлов. |
| CardTypeName | Имя типа карточки с преобразуемым файлом, который указывается в запросе на конвертацию CardGetFileContentRequest.CardTypeName, или null, если свойство не указывается в запросе. От значения этого свойства не зависит вычисление хеша запроса (и идентификация похожих операций). Значение необязательно для заполнения, его можно использовать для конвертации виртуальных файлов. |
| EventName | Алиас события, для которого выполняется предпросмотр. Значение используется для вычисления хеша запроса. Список стандартных алиасов можно получить из класса [Tessa.FileConverters.FileConverterEventNames]. |
| FileID | Идентификатор преобразуемого файла. |
| FileName | Имя преобразуемого файла. При установке автоматически определяет и устанавливает значение свойства [Tessa.FileConverters.IFileConverterRequest.InputFormat]. |
| FileRequestInfo | Дополнительная информация, передаваемая в запрос на конвертацию CardGetFileContentRequest.Info. От такой информации зависит вычисление хеша запроса (и идентификация похожих операций). Если от некоторой части этих данных должен зависеть хеш запроса, то скопируйте их в свойство Parameters. Значение необязательно для заполнения, его можно использовать для конвертации виртуальных файлов. |
| FileTypeID | Идентификатор типа преобразуемого файла, который указывается в запросе на конвертацию CardGetFileContentRequest.FileTypeID, или null, если свойство не указывается в запросе. От значения этого свойства зависит вычисление хеша запроса (и идентификация похожих операций). Значение необязательно для заполнения, его можно использовать для конвертации виртуальных файлов. |
| FileTypeName | Имя типа преобразуемого файла, который указывается в запросе на конвертацию CardGetFileContentRequest.FileTypeName, или null, если свойство не указывается в запросе. От значения этого свойства зависит вычисление хеша запроса (и идентификация похожих операций). Значение необязательно для заполнения, его можно использовать для конвертации виртуальных файлов. |
| Flags | Флаги с настройками конвертации файлов. |
| Info | Дополнительная информация, передаваемая в параметры конвертации. От такой информации не зависит вычисление хеша запроса (и идентификация похожих операций), в отличие от данных в свойстве [Tessa.FileConverters.IFileConverterRequest.Parameters]. |
| InputFormat | Формат преобразуемого файла. Устанавливайте значение этого свойства после установки [Tessa.FileConverters.IFileConverterRequest.FileName]. |
| IsSealed | Признак того, что объект был защищён от изменений. (Унаследован от ISealable) |
| OutputFormat | Выходной формат файла. Значение используется для вычисления хеша запроса. |
| Parameters | Дополнительная информация, передаваемая в параметры конвертации, которая влияет на вычисление хеша запроса. Файлы, сгенерированные с разными параметрами, могут конвертироваться параллельно и могут сохраняться в кэш одновременно. Если параметры идентичны (а также свойства VersionID, EventName и OutputFormat), то система считает запросы идентичными, выполнит конвертацию ровно один раз и вернёт результат из кэша. |
| SkipFileValidation | Определяет необходимость проверки идентификаторов карточки и файла, что они соответствуют идентификатору версии файла перед получением контента стандартным способом (без переопределения функции возврата контента в расширениях для виртуальных файлов). Не сериализуeтся. Это свойство используется платформой, не рекомендуется устанавливать его значение вручную. |
| VersionID | Идентификатор версии преобразуемого файла. Значение используется для вычисления хеша запроса. |
| CalculateHash | Вычисляет хеш операции по конвертации для данного запроса, по которому, в том числе, выполняется сравнение операций и их результатов в кэше. По умолчанию учитываются значения свойств VersionID, EventName, OutputFormat и Parameters. |
| Deserialize | Десериализует информацию из заданного хранилища в свойства текущего объекта. |
| Seal | Защищает объект от изменений. (Унаследован от ISealable) |
| Serialize | Сериализует информацию в заданном хранилище для передачи в запускаемую операцию. |
| CreateCardGetFileContentRequest |
Возвращает запрос на получение контента версии файла, прикреплённого к карточке, на основе данных из запроса на конвертацию файла.
(Определяется FileConverterExtensions) |
| SetPdfFilter |
Устанавливает дополнительные фильтры в параметры запроса на конвертацию файла.
(Определяется FileConverterExtensions) |
| TryGetPdfFilter |
Возвращает дополнительные фильтры из параметров запроса на конвертацию файла.
(Определяется FileConverterExtensions) |