API Reference
Class
HtmlPdfConverterExtensions
Converts a parsed OfficeIMO HTML source document through the shared HTML render scene.
Inheritance
- Object
- HtmlPdfConverterExtensions
Methods
public static Byte[] RenderToPdfBytes(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
Byte[]Executes an explicit PDF render request and serializes the resulting document.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static async Task<Byte[]> RenderToPdfBytesAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
Task<Byte[]>Executes an explicit PDF render request and asynchronously serializes the result.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static PdfDocumentConversionResult RenderToPdfDocumentResult(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
PdfDocumentConversionResultExecutes an explicit PDF render request and returns the PDF plus its conversion report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static async Task<PdfDocumentConversionResult> RenderToPdfDocumentResultAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
Task<PdfDocumentConversionResult>Asynchronously executes an explicit PDF render request and returns the PDF plus its conversion report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static HtmlPdfRenderRequestResult RenderToPdfResult(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
HtmlPdfRenderRequestResultExecutes an explicit request and returns its retained surfaces together with the PDF output.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static async Task<HtmlPdfRenderRequestResult> RenderToPdfResultAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
Task<HtmlPdfRenderRequestResult>Asynchronously executes an explicit request and returns its retained surfaces with the PDF output.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
SaveAsPdf 2 overloads
public static PdfSaveResult SaveAsPdf(HtmlConversionDocument document, String path, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultConverts a parsed HTML document and saves it as a PDF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static PdfSaveResult SaveAsPdf(HtmlConversionDocument document, Stream pdfStream, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultConverts a parsed HTML document and writes it as PDF to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- pdfStream System.IO.Stream
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
SaveAsPdfAsync 2 overloads
public static async Task<PdfSaveResult> SaveAsPdfAsync(HtmlConversionDocument document, String path, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Asynchronously converts a parsed HTML document and saves it as a PDF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<PdfSaveResult> SaveAsPdfAsync(HtmlConversionDocument document, Stream pdfStream, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Asynchronously converts a parsed HTML document and writes it as PDF to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- pdfStream System.IO.Stream
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
SaveAsPdfResult 2 overloads
public static PdfSaveResult SaveAsPdfResult(HtmlConversionDocument document, String path, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultAttempts to convert a parsed HTML document and save it as a PDF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static PdfSaveResult SaveAsPdfResult(HtmlConversionDocument document, Stream pdfStream, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultAttempts to convert a parsed HTML document and write it as PDF to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- pdfStream System.IO.Stream
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
SaveAsPdfResultAsync 2 overloads
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(HtmlConversionDocument document, String path, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Asynchronously attempts to convert a parsed HTML document and save it as a PDF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(HtmlConversionDocument document, Stream pdfStream, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Asynchronously attempts to convert a parsed HTML document and write it as PDF to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- pdfStream System.IO.Stream
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static Byte[] ToPdfBytes(HtmlConversionDocument document, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Byte[]Converts a parsed HTML document to PDF bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<Byte[]> ToPdfBytesAsync(HtmlConversionDocument document, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<Byte[]>Asynchronously resolves HTML resources and converts a parsed HTML document to PDF bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static PdfDocument ToPdfDocument(HtmlConversionDocument document, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
PdfDocumentConverts a parsed HTML document to the first-party PDF document model.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<PdfDocument> ToPdfDocumentAsync(HtmlConversionDocument document, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfDocument>Asynchronously converts a parsed HTML document to the first-party PDF document model.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static PdfDocumentConversionResult ToPdfDocumentResult(HtmlConversionDocument document, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
PdfDocumentConversionResultConverts a parsed HTML document to PDF plus an immutable diagnostics snapshot.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<PdfDocumentConversionResult> ToPdfDocumentResultAsync(HtmlConversionDocument document, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfDocumentConversionResult>Asynchronously converts a parsed HTML document to PDF plus an immutable diagnostics snapshot.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?