# AsciiDocPdfConverterExtensions

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

Class 

`OfficeIMO.AsciiDoc.Pdf`

**Namespace**

`OfficeIMO.AsciiDoc.Pdf`

**Assembly**

`OfficeIMO.AsciiDoc.Pdf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[AsciiDocPdfConverterExtensions.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Pdf/AsciiDocPdfConverterExtensions.cs#L18)

**Modifiers**

static

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

## Inheritance

- object
- AsciiDocPdfConverterExtensions

Filter members 

Show inherited

## Methods

SaveAsPdf 2 overloads

`public static OfficeConversionReport SaveAsPdf(AsciiDocDocument document, string path, AsciiDocPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaspdf-officeimo-asciidoc-asciidocdocument-string-officeimo-asciidoc-pdf-asciidocpdfexportoptions-threading-cancellationtoken)

[AsciiDocPdfConverterExtensions.cs:47](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Pdf/AsciiDocPdfConverterExtensions.cs#L47)

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)` [#](#method-saveaspdf-officeimo-asciidoc-asciidocdocument-io-stream-officeimo-asciidoc-pdf-asciidocpdfexportoptions-threading-cancellationtoken)

[AsciiDocPdfConverterExtensions.cs:61](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Pdf/AsciiDocPdfConverterExtensions.cs#L61)

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)` [#](#method-saveaspdfasync-officeimo-asciidoc-asciidocdocument-string-officeimo-asciidoc-pdf-asciidocpdfexportoptions-threading-cancellationtoken)

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)` [#](#method-saveaspdfasync-officeimo-asciidoc-asciidocdocument-io-stream-officeimo-asciidoc-pdf-asciidocpdfexportoptions-threading-cancellationtoken)

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)` [#](#method-topdf-officeimo-asciidoc-asciidocdocument-officeimo-asciidoc-pdf-asciidocpdfexportoptions-threading-cancellationtoken)

[AsciiDocPdfConverterExtensions.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Pdf/AsciiDocPdfConverterExtensions.cs#L18)

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)` [#](#method-topdf-officeimo-asciidoc-asciidocdocument-officeimo-asciidoc-pdf-asciidocpdfexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[AsciiDocPdfConverterExtensions.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Pdf/AsciiDocPdfConverterExtensions.cs#L23)

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)` [#](#method-topdfasync-officeimo-asciidoc-asciidocdocument-officeimo-asciidoc-pdf-asciidocpdfexportoptions-threading-cancellationtoken)

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>>`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

<!-- PowerForge markdown artifact sha256:7C18FAF659AE0B21C29F16938B5E2CB20E74CCB0D3399FB6664539A75AAB5550 -->
