Class PdfRequestExtensions

Namespace: CobaltPdf

Assembly: CobaltPdf.dll

Extension methods that execute a CobaltPdf.Requests.PdfRequest using a CobaltEngine instance.

public static class PdfRequestExtensions

Inheritance: object

PdfRequestExtensions

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

These extensions live in the CobaltPDF package (not CobaltPDF.Requests) because they depend on CobaltEngine. Install CobaltPDF.Requests on the client and CobaltPDF on the rendering service; both share the same CobaltPdf.Requests.PdfRequest model.

Methods

ExecuteAsync(PdfRequest, CobaltEngine, CancellationToken)

Executes a CobaltPdf.Requests.PdfRequest against the supplied engine, mapping all request properties to the CobaltPdf fluent API internally.

public static Task<PdfDocument> ExecuteAsync(this PdfRequest request, CobaltEngine engine, CancellationToken cancellationToken = default)

Parameters

request PdfRequest: The populated request model.
engine CobaltEngine: The CobaltEngine instance to render with.
cancellationToken CancellationToken: Optional cancellation token.

Returns

Task<PdfDocument>: The rendered PdfDocument.

Examples

// Azure Function handler
var request = await req.ReadFromJsonAsync<PdfRequest>();
var pdf = await request.ExecuteAsync(_renderer, cancellationToken);

Exceptions

ArgumentException: Thrown when neither CobaltPdf.Requests.PdfRequest.Url nor CobaltPdf.Requests.PdfRequest.Html is provided, or when both are provided simultaneously.

Table of Contents