API Reference
Class
MarkdownPdfConverterExtensions
First-party Markdown to PDF conversion helpers.
Inheritance
- Object
- MarkdownPdfConverterExtensions
Methods
SaveAsPdf 2 overloads
public static PdfSaveResult SaveAsPdf(MarkdownDoc document, String path, MarkdownToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultSaves a Markdown document model as a PDF file.
Parameters
- arg1 OfficeIMO.Markdown.MarkdownDoc
- arg2 System.String
- arg3 OfficeIMO.Markdown.Pdf.MarkdownToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static PdfSaveResult SaveAsPdf(MarkdownDoc document, Stream stream, MarkdownToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultWrites a Markdown document model as PDF to a stream.
Parameters
- arg1 OfficeIMO.Markdown.MarkdownDoc
- arg2 System.IO.Stream
- arg3 OfficeIMO.Markdown.Pdf.MarkdownToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
SaveAsPdfAsync 2 overloads
public static Task<PdfSaveResult> SaveAsPdfAsync(MarkdownDoc document, String path, MarkdownToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Converts synchronously, then asynchronously saves a Markdown PDF at the specified path.
Parameters
- arg1 OfficeIMO.Markdown.MarkdownDoc
- arg2 System.String
- arg3 OfficeIMO.Markdown.Pdf.MarkdownToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static Task<PdfSaveResult> SaveAsPdfAsync(MarkdownDoc document, Stream stream, MarkdownToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Converts synchronously, then asynchronously saves a Markdown PDF to a caller-owned stream.
Parameters
- arg1 OfficeIMO.Markdown.MarkdownDoc
- arg2 System.IO.Stream
- arg3 OfficeIMO.Markdown.Pdf.MarkdownToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
SaveAsPdfResult 2 overloads
public static PdfSaveResult SaveAsPdfResult(MarkdownDoc document, String path, MarkdownToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultAttempts to save a Markdown document model as a PDF file and returns output diagnostics instead of throwing.
Parameters
- arg1 OfficeIMO.Markdown.MarkdownDoc
- arg2 System.String
- arg3 OfficeIMO.Markdown.Pdf.MarkdownToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static PdfSaveResult SaveAsPdfResult(MarkdownDoc document, Stream stream, MarkdownToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultAttempts to write a Markdown document model as PDF to a stream and returns output diagnostics instead of throwing.
Parameters
- arg1 OfficeIMO.Markdown.MarkdownDoc
- arg2 System.IO.Stream
- arg3 OfficeIMO.Markdown.Pdf.MarkdownToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
SaveAsPdfResultAsync 2 overloads
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(MarkdownDoc document, String path, MarkdownToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Attempts to asynchronously save a Markdown document model as PDF at the specified path.
Parameters
- arg1 OfficeIMO.Markdown.MarkdownDoc
- arg2 System.String
- arg3 OfficeIMO.Markdown.Pdf.MarkdownToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(MarkdownDoc document, Stream stream, MarkdownToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Attempts to asynchronously save a Markdown document model as PDF to a caller-owned stream.
Parameters
- arg1 OfficeIMO.Markdown.MarkdownDoc
- arg2 System.IO.Stream
- arg3 OfficeIMO.Markdown.Pdf.MarkdownToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static Byte[] ToPdfBytes(MarkdownDoc document, MarkdownToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Byte[]Converts a Markdown document model to PDF bytes.
Parameters
- document OfficeIMO.Markdown.MarkdownDoc
- options OfficeIMO.Markdown.Pdf.MarkdownToPdfOptions = null
- cancellationToken System.Threading.CancellationToken = default
Examples
byte[] pdf = document.ToPdfBytes();
public static PdfDocument ToPdfDocument(MarkdownDoc document, MarkdownToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfDocumentConverts a Markdown document model to a first-party OfficeIMO PDF document model.
Parameters
- document OfficeIMO.Markdown.MarkdownDoc
- options OfficeIMO.Markdown.Pdf.MarkdownToPdfOptions = null
- cancellationToken System.Threading.CancellationToken = default
public static PdfDocumentConversionResult ToPdfDocumentResult(MarkdownDoc document, MarkdownToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfDocumentConversionResultConverts a Markdown document model to a PDF document and returns conversion diagnostics with it.
Parameters
- document OfficeIMO.Markdown.MarkdownDoc
- options OfficeIMO.Markdown.Pdf.MarkdownToPdfOptions = null
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object