CardExtensionsGenerateFileFromTemplateAsync(ICardStreamServerRepository, Guid, NullableGuid, IViewPlaceholderContext, DictionaryString, Object, DictionaryString, Object, CancellationToken) - метод
Асинхронно создаёт файл по заданному шаблону и возвращает контент созданного файла и ответ на запрос на создание.
Пространство имён: Tessa.CardsСборка: Tessa (в Tessa.dll) Версия: 4.0.4
public static Task<ICardFileContentResult> GenerateFileFromTemplateAsync(
this ICardStreamServerRepository repository,
Guid templateID,
Guid? cardID,
IViewPlaceholderContext? viewPlaceholderContext = null,
Dictionary<string, Object?>? info = null,
Dictionary<string, Object?>? requestInfo = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function GenerateFileFromTemplateAsync (
repository As ICardStreamServerRepository,
templateID As Guid,
cardID As Guid?,
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 ICardFileContentResult)
public:
[ExtensionAttribute]
static Task<ICardFileContentResult^>^ GenerateFileFromTemplateAsync(
ICardStreamServerRepository^ repository,
Guid templateID,
Nullable<Guid> cardID,
IViewPlaceholderContext^ viewPlaceholderContext = nullptr,
Dictionary<String^, Object^>^ info = nullptr,
Dictionary<String^, Object^>^ requestInfo = nullptr,
CancellationToken cancellationToken = CancellationToken()
)
[<ExtensionAttribute>]
static member GenerateFileFromTemplateAsync :
repository : ICardStreamServerRepository *
templateID : Guid *
cardID : Nullable<Guid> *
?viewPlaceholderContext : IViewPlaceholderContext *
?info : Dictionary<string, Object> *
?requestInfo : Dictionary<string, Object> *
?cancellationToken : CancellationToken
(* Defaults:
let _viewPlaceholderContext = defaultArg viewPlaceholderContext null
let _info = defaultArg info null
let _requestInfo = defaultArg requestInfo null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<ICardFileContentResult>
- repository ICardStreamServerRepository
- Репозиторий для получения контента на клиенте.
- templateID Guid
- Идентификатор карточки шаблона файла.
- cardID NullableGuid
-
Идентификатор карточки, используемый в плейсхолдерах шаблона,
или null, если шаблон создаётся без привязки к карточке.
- viewPlaceholderContext IViewPlaceholderContext (Optional)
-
Контекст плейсхолдеров для представлений
или null, если шаблон создаётся без привязки к представлению.
- info DictionaryString, Object (Optional)
-
Дополнительная информация, передаваемая в запрос на получение контента файла,
или null, если дополнительная информация не передаётся.
Из запроса на получение контента файла эту информацию можно получить по ключу PlaceholderUserInfoKey.
При формировании шаблона эта информация будет доступна из контекста плейсхолдера по тем же ключам, которые заданы в параметре,
например: context.Info["Key"].
- requestInfo DictionaryString, Object (Optional)
-
Дополнительная информация, передаваемая в запрос на получение контента файла,
или null, если дополнительная информация не передаётся.
Из запроса на получение контента файла эту информацию можно получить по тем же ключам, которые заданы в параметре,
например: context.Info["Key"].
- cancellationToken CancellationToken (Optional)
- Объект, посредством которого можно отменить асинхронную задачу.
TaskICardFileContentResult
Задача, возвращающая ответ на запрос на получение контента файла, созданного по шаблону, и собственно сам контент файла.
В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа
ICardStreamServerRepository. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе
Методы расширения (Visual Basic) или
Методы расширения (Руководство по программированию в C#).