Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

MarkdownPdfConverterExtensions

OfficeIMO.Markdown.Pdf

Namespace
OfficeIMO.Markdown.Pdf
Assembly
OfficeIMO.Markdown.Pdf
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

First-party Markdown to PDF conversion helpers.

Inheritance

  • object
  • MarkdownPdfConverterExtensions

Methods

SaveAsPdf 2 overloads
public static OfficeConversionReport SaveAsPdf(MarkdownDocument document, string path, MarkdownPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes a PDF file and returns the complete conversion report.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
path string required
options OfficeIMO.Markdown.Pdf.MarkdownPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsPdf(MarkdownDocument document, Stream stream, MarkdownPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes PDF to a caller-owned stream and returns the complete conversion report.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
stream System.IO.Stream required
options OfficeIMO.Markdown.Pdf.MarkdownPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsPdfAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsPdfAsync(MarkdownDocument document, string path, MarkdownPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes a PDF file and returns the complete conversion report.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
path string required
options OfficeIMO.Markdown.Pdf.MarkdownPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsPdfAsync(MarkdownDocument document, Stream stream, MarkdownPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes PDF to a caller-owned stream and returns its conversion report.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
stream System.IO.Stream required
options OfficeIMO.Markdown.Pdf.MarkdownPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToPdf 2 overloads
public static PdfDocument ToPdf(MarkdownDocument document, MarkdownPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the source document to a PDF model.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
options OfficeIMO.Markdown.Pdf.MarkdownPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

PdfDocument
public static PdfDocument ToPdf(MarkdownDocument document, MarkdownPdfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts the source document and returns its completed conversion findings.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
options OfficeIMO.Markdown.Pdf.MarkdownPdfExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

PdfDocument
public static async Task<OfficeConversionResult<PdfDocument>> ToPdfAsync(MarkdownDocument document, MarkdownPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the source document, returning the model and report together.

Parameters

document OfficeIMO.Markdown.MarkdownDocument required
options OfficeIMO.Markdown.Pdf.MarkdownPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<PdfDocument>>