API Reference
Class
AsciiDocPdfConverterExtensions
Converts native AsciiDoc documents through the loss-aware Markdown projection to first-party PDFs.
Inheritance
- Object
- AsciiDocPdfConverterExtensions
Methods
SaveAsPdf 2 overloads
public static PdfSaveResult SaveAsPdf(AsciiDocDocument document, String path, AsciiDocToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultSaves an AsciiDoc document as PDF and returns combined conversion diagnostics.
Parameters
- arg1 OfficeIMO.AsciiDoc.AsciiDocDocument
- arg2 System.String
- arg3 OfficeIMO.AsciiDoc.Pdf.AsciiDocToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static PdfSaveResult SaveAsPdf(AsciiDocDocument document, Stream stream, AsciiDocToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultWrites an AsciiDoc document as PDF to a caller-owned stream.
Parameters
- arg1 OfficeIMO.AsciiDoc.AsciiDocDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.AsciiDoc.Pdf.AsciiDocToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
SaveAsPdfAsync 2 overloads
public static Task<PdfSaveResult> SaveAsPdfAsync(AsciiDocDocument document, String path, AsciiDocToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Converts synchronously, then asynchronously writes an AsciiDoc PDF to a path.
Parameters
- arg1 OfficeIMO.AsciiDoc.AsciiDocDocument
- arg2 System.String
- arg3 OfficeIMO.AsciiDoc.Pdf.AsciiDocToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static Task<PdfSaveResult> SaveAsPdfAsync(AsciiDocDocument document, Stream stream, AsciiDocToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Converts synchronously, then asynchronously writes an AsciiDoc PDF to a caller-owned stream.
Parameters
- arg1 OfficeIMO.AsciiDoc.AsciiDocDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.AsciiDoc.Pdf.AsciiDocToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
SaveAsPdfResult 2 overloads
public static PdfSaveResult SaveAsPdfResult(AsciiDocDocument document, String path, AsciiDocToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultAttempts to save an AsciiDoc PDF and returns structured failure evidence.
Parameters
- arg1 OfficeIMO.AsciiDoc.AsciiDocDocument
- arg2 System.String
- arg3 OfficeIMO.AsciiDoc.Pdf.AsciiDocToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static PdfSaveResult SaveAsPdfResult(AsciiDocDocument document, Stream stream, AsciiDocToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultAttempts to write an AsciiDoc PDF to a caller-owned stream.
Parameters
- arg1 OfficeIMO.AsciiDoc.AsciiDocDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.AsciiDoc.Pdf.AsciiDocToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
SaveAsPdfResultAsync 2 overloads
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(AsciiDocDocument document, String path, AsciiDocToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Converts synchronously, then attempts to asynchronously save an AsciiDoc PDF.
Parameters
- arg1 OfficeIMO.AsciiDoc.AsciiDocDocument
- arg2 System.String
- arg3 OfficeIMO.AsciiDoc.Pdf.AsciiDocToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(AsciiDocDocument document, Stream stream, AsciiDocToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Converts synchronously, then attempts to asynchronously write an AsciiDoc PDF.
Parameters
- arg1 OfficeIMO.AsciiDoc.AsciiDocDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.AsciiDoc.Pdf.AsciiDocToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static Byte[] ToPdfBytes(AsciiDocDocument document, AsciiDocToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Byte[]Converts an AsciiDoc document to PDF bytes.
Parameters
- document OfficeIMO.AsciiDoc.AsciiDocDocument
- options OfficeIMO.AsciiDoc.Pdf.AsciiDocToPdfOptions = null
- cancellationToken System.Threading.CancellationToken = default
public static PdfDocument ToPdfDocument(AsciiDocDocument document, AsciiDocToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfDocumentConverts an AsciiDoc document to a first-party PDF document.
Parameters
- document OfficeIMO.AsciiDoc.AsciiDocDocument
- options OfficeIMO.AsciiDoc.Pdf.AsciiDocToPdfOptions = null
- cancellationToken System.Threading.CancellationToken = default
public static PdfDocumentConversionResult ToPdfDocumentResult(AsciiDocDocument document, AsciiDocToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfDocumentConversionResultConverts an AsciiDoc document and combines parser, semantic-projection, and PDF diagnostics.
Parameters
- document OfficeIMO.AsciiDoc.AsciiDocDocument
- options OfficeIMO.AsciiDoc.Pdf.AsciiDocToPdfOptions = null
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object