Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

AsciiDocPdfConverterExtensions

OfficeIMO.AsciiDoc.Pdf

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

Converts native AsciiDoc documents through the loss-aware Markdown projection to first-party PDFs.

Inheritance

  • object
  • AsciiDocPdfConverterExtensions

Methods

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

Writes the AsciiDoc document as a PDF file and returns the complete conversion report.

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
path string required
options OfficeIMO.AsciiDoc.Pdf.AsciiDocPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

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

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
stream System.IO.Stream required
options OfficeIMO.AsciiDoc.Pdf.AsciiDocPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

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

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
path string required
options OfficeIMO.AsciiDoc.Pdf.AsciiDocPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Asynchronously writes the AsciiDoc document as PDF to a caller-owned stream and returns the complete conversion report.

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
stream System.IO.Stream required
options OfficeIMO.AsciiDoc.Pdf.AsciiDocPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Converts the AsciiDoc document to a PDF model.

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
options OfficeIMO.AsciiDoc.Pdf.AsciiDocPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Converts the AsciiDoc document and returns its completed conversion findings.

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
options OfficeIMO.AsciiDoc.Pdf.AsciiDocPdfExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

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

Parameters

document OfficeIMO.AsciiDoc.AsciiDocDocument required
options OfficeIMO.AsciiDoc.Pdf.AsciiDocPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<PdfDocument>>