IFileConverterContext - интерфейс |
Пространство имён: Tessa.FileConverters
public interface IFileConverterContext : IExtensionContext
Тип IFileConverterContext предоставляет следующие члены.
Имя | Описание | |
---|---|---|
![]() | CancellationToken | Объект, посредством которого можно отменить асинхронную задачу. (Унаследован от IExtensionContext.) |
![]() | Info |
Неструктурированная информация для цепочки расширений.
Такая информация нигде не сохраняется после завершения конвертации.
|
![]() | InputExtension |
Расширение для конвертируемого файла. Задаётся как расширение файла в нижнем регистре без ведущей точки.
Может быть равно null или пустой строке, если у файла нет расширения.
|
![]() | InputFilePath | Путь к файлу для пребразования. |
![]() | Operation |
Операция, в рамках которой выполняется конвертация,
или null, если операция неизвестна или отсутствует.
Из операции можно получить информацию по тому, какой сотрудник создал запрос на конвертацию,
и, например, в соответствии с этим локализовать сообщения.
|
![]() | OutputExtension |
Расширение для выходного формата файла. Задаётся как расширение файла в нижнем регистре без ведущей точки.
Может быть равно null или пустой строке, если у файла нет расширения.
|
![]() | OutputFilePath |
Путь к выходному файлу. Может быть изменён, если приложение-конвертер записало файл по другому пути.
Не может быть равен null или пустой строке.
|
![]() | Request |
Запрос на выполнение операции, в рамках которого выполняется конвертация,
или null, если запрос неизвестен или отсутствует.
|
![]() | RequestInfo |
Информация, полученная из запроса на выполнение операции.
В отличие от свойства Request, это возвращаемое значение не равно null,
причём при отсутствии информации по запросу будет получен пустой объект.
|
![]() | RequestIsSuccessful |
Признак того, что запрос успешно выполнен. Проверять значение рекомендуется
только в методах расширений AfterRequest.
|
![]() | RequestParameters |
Параметры, полученные из запроса на выполнение операции, которые влияют на вычисление хеша запроса.
Файлы, сгенерированные с разными параметрами, могут конвертироваться параллельно и могут сохраняться в кэш одновременно.
В отличие от свойства Request, это возвращаемое значение не равно null,
причём при отсутствии информации по запросу будет получен пустой объект.
|
![]() | ResponseInfo | Информация, передаваемая вместе с результатом выполнения операции. |
![]() | ValidationResult |
Результат валидации, содержащий сообщения, возникающие в процессе конвертации.
Если сообщения содержат ошибки, то считается, что конвертация не выполнена и выходной файл может отсутствовать.
|
Имя | Описание | |
---|---|---|
![]() | GetOutputStreamOrThrow |
Возвращает поток на выходной файл или выбрасывает исключение,
если файл не найден или произошла другая ошибка при его открытии.
Возвращённый поток необходимо закрыть вызовом Dispose().
(Определяется FileConverterExtensions.) |