WordPdfConverterExtensions
OfficeIMO.Word.Pdf
Provides extension methods for converting WordDocument instances to PDF files.
Inheritance
- object
- WordPdfConverterExtensions
Methods
public static OfficeConversionReport SaveAsPdf(WordDocument document, string path, WordPdfExportOptions? options = null, CancellationToken cancellationToken = default) #Writes a PDF file and returns the complete conversion report.
Parameters
- document OfficeIMO.Word.WordDocument
- path string
- options OfficeIMO.Word.Pdf.WordPdfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsPdf(WordDocument document, Stream stream, WordPdfExportOptions? options = null, CancellationToken cancellationToken = default) #Writes PDF to a caller-owned stream and returns the complete conversion report.
Parameters
- document OfficeIMO.Word.WordDocument
- stream System.IO.Stream
- options OfficeIMO.Word.Pdf.WordPdfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static async Task<OfficeConversionReport> SaveAsPdfAsync(WordDocument document, string path, WordPdfExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously writes a PDF file and returns the complete conversion report.
Parameters
- document OfficeIMO.Word.WordDocument
- path string
- options OfficeIMO.Word.Pdf.WordPdfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static async Task<OfficeConversionReport> SaveAsPdfAsync(WordDocument document, Stream stream, WordPdfExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously writes PDF to a caller-owned stream and returns its conversion report.
Parameters
- document OfficeIMO.Word.WordDocument
- stream System.IO.Stream
- options OfficeIMO.Word.Pdf.WordPdfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static PdfDocument ToPdf(WordDocument document, WordPdfExportOptions? options = null, CancellationToken cancellationToken = default) #Converts the source document to a PDF model.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Word.Pdf.WordPdfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
PdfDocumentpublic static PdfDocument ToPdf(WordDocument document, WordPdfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Converts the source document and returns its completed conversion findings.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Word.Pdf.WordPdfExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
PdfDocumentpublic static async Task<OfficeConversionResult<PdfDocument>> ToPdfAsync(WordDocument document, WordPdfExportOptions? options = null, CancellationToken cancellationToken = default) #Converts the source document, returning the model and report together.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Word.Pdf.WordPdfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<PdfDocument>>public static WordFieldUpdateOptions WithPdfLayoutPagination(WordFieldUpdateOptions options) #Returns independent field-update options using the native PDF layout for bookmark and page-count fields.
Parameters
- options OfficeIMO.Word.WordFieldUpdateOptions
- Field refresh settings to copy; the caller's instance is unchanged.
Returns
WordFieldUpdateOptions Options that paginate a private document copy after any requested table-of-contents regeneration.