FileConverterExtensionsGetRequestOrThrowAsync - метод |
Возвращает запрос на выполнение операции по конвертации заданной версии файла в карточке.
Возвращаемое значение гарантированно не равно null.
Если параметры файла не найдены по идентификатору версии, то выбрасывается исключение.
Пространство имён:
Tessa.FileConverters
Сборка:
Tessa (в Tessa.dll) Версия: 3.5.0.19
Синтаксис public static Task<IFileConverterRequest> GetRequestOrThrowAsync(
this IFileConverter fileConverter,
string eventName,
FileConverterFormat outputFormat,
Guid versionID,
Dictionary<string, Object> info = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function GetRequestOrThrowAsync (
fileConverter As IFileConverter,
eventName As String,
outputFormat As FileConverterFormat,
versionID As Guid,
Optional info As Dictionary(Of String, Object) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IFileConverterRequest)
public:
[ExtensionAttribute]
static Task<IFileConverterRequest^>^ GetRequestOrThrowAsync(
IFileConverter^ fileConverter,
String^ eventName,
FileConverterFormat outputFormat,
Guid versionID,
Dictionary<String^, Object^>^ info = nullptr,
CancellationToken cancellationToken = CancellationToken()
)
[<ExtensionAttribute>]
static member GetRequestOrThrowAsync :
fileConverter : IFileConverter *
eventName : string *
outputFormat : FileConverterFormat *
versionID : Guid *
?info : Dictionary<string, Object> *
?cancellationToken : CancellationToken
(* Defaults:
let _info = defaultArg info null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IFileConverterRequest>
Параметры
- fileConverter
- Тип: Tessa.FileConvertersIFileConverter
Объект, выполнющий преобразование файлов из одного формата в другой. - eventName
- Тип: SystemString
Алиас события, для которого выполняется предпросмотр.
Список стандартных алиасов можно получить из класса FileConverterEventNames.
Если указано значение null/пустая строка, то используется константа Unknown.
- outputFormat
- Тип: Tessa.FileConvertersFileConverterFormat
Выходной формат файла. - versionID
- Тип: SystemGuid
Идентификатор версии преобразуемого файла. - info (Optional)
- Тип: System.Collections.GenericDictionaryString, Object
Дополнительная информация, передаваемая в параметры конвертации,
или null, если дополнительная информация отсутствует.
- cancellationToken (Optional)
- Тип: System.ThreadingCancellationToken
Объект, посредством которого можно отменить асинхронную задачу.
Возвращаемое значение
Тип:
TaskIFileConverterRequest
Запрос на выполнение операции по конвертации заданной версии.
Возвращаемое значение гарантированно не равно
null.
Примечание об использовании
В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа
IFileConverter. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе
Методы расширения (Visual Basic) или
Методы расширения (Руководство по программированию в C#).
Исключения См. также