CardExtensions.GenerateFileFromTemplateAsync(ICardStreamClientRepository, Guid, Nullable<Guid>, Func<Stream, CancellationToken, ValueTask>, Boolean, String, IViewPlaceholderContext, Dictionary<String, Object>, Dictionary<String, Object>, CancellationToken) - метод
Создаёт файл по заданному шаблону и возвращает контент созданного файла и ответ на запрос на создание.
Пространство имён: Tessa.CardsСборка: Tessa (в Tessa.dll) Версия: 4.0.6
public static Task<CardGetFileContentResponse> GenerateFileFromTemplateAsync(
this ICardStreamClientRepository repository,
Guid templateID,
Guid? cardID,
Func<Stream, CancellationToken, ValueTask> processContentActionAsync,
bool convertToPdf,
string fileName,
IViewPlaceholderContext? viewPlaceholderContext = null,
Dictionary<string, Object?>? info = null,
Dictionary<string, Object?>? requestInfo = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function GenerateFileFromTemplateAsync (
repository As ICardStreamClientRepository,
templateID As Guid,
cardID As Guid?,
processContentActionAsync As Func(Of Stream, CancellationToken, ValueTask),
convertToPdf As Boolean,
fileName As String,
Optional viewPlaceholderContext As IViewPlaceholderContext = Nothing,
Optional info As Dictionary(Of String, Object) = Nothing,
Optional requestInfo As Dictionary(Of String, Object) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of CardGetFileContentResponse)
public:
[ExtensionAttribute]
static Task<CardGetFileContentResponse^>^ GenerateFileFromTemplateAsync(
ICardStreamClientRepository^ repository,
Guid templateID,
Nullable<Guid> cardID,
Func<Stream^, CancellationToken, ValueTask>^ processContentActionAsync,
bool convertToPdf,
String^ fileName,
IViewPlaceholderContext^ viewPlaceholderContext = nullptr,
Dictionary<String^, Object^>^ info = nullptr,
Dictionary<String^, Object^>^ requestInfo = nullptr,
CancellationToken cancellationToken = CancellationToken()
)
[<ExtensionAttribute>]
static member GenerateFileFromTemplateAsync :
repository : ICardStreamClientRepository *
templateID : Guid *
cardID : Nullable<Guid> *
processContentActionAsync : Func<Stream, CancellationToken, ValueTask> *
convertToPdf : bool *
fileName : string *
?viewPlaceholderContext : IViewPlaceholderContext *
?info : Dictionary<string, Object> *
?requestInfo : Dictionary<string, Object> *
?cancellationToken : CancellationToken
-> Task<CardGetFileContentResponse>
- repository ICardStreamClientRepository
- Репозиторий для получения контента на клиенте.
- templateID Guid
- Идентификатор карточки шаблона файла.
- cardID Nullable<Guid>
-
Идентификатор карточки, используемый в плейсхолдерах шаблона,
или null, если шаблон создаётся без привязки к карточке.
- processContentActionAsync Func<Stream, CancellationToken, ValueTask>
-
Метод, выполняющий чтение и обработку контента версии файла. Метод не вызывается, если контент файла не был передан.
- convertToPdf Boolean
-
Значение, указывающее на то нужна ли конвертация в PDF при созданити файла по шаблону.
- fileName String
- Имя генерируемого файла.
- viewPlaceholderContext IViewPlaceholderContext (Optional)
-
Контекст плейсхолдеров для представлений
или null, если шаблон создаётся без привязки к представлению.
- info Dictionary<String, Object> (Optional)
-
Дополнительная информация, передаваемая в запрос на получение контента файла,
или null, если дополнительная информация не передаётся.
Из запроса на получение контента файла эту информацию можно получить по ключу PlaceholderUserInfoKey.
При формировании шаблона эта информация будет доступна из контекста плейсхолдера по тем же ключам, которые заданы в параметре,
например: context.Info["Key"].
- requestInfo Dictionary<String, Object> (Optional)
-
Дополнительная информация, передаваемая в запрос на получение контента файла,
или null, если дополнительная информация не передаётся.
Из запроса на получение контента файла эту информацию можно получить по тем же ключам, которые заданы в параметре,
например: context.Info["Key"].
- cancellationToken CancellationToken (Optional)
-
Объект, посредством которого можно отменить выполнение запроса с клиента на сервер.
Укажите значение по умолчанию CancellationToken.None, если отмена не требуется.
Task<CardGetFileContentResponse>Ответ на запрос на получение контента файла, созданного по шаблону.В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа
ICardStreamClientRepository. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе
Методы расширения (Visual Basic) или
Методы расширения (Руководство по программированию в C#).