Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

PublisherPdfConversionExtensions

OfficeIMO.Publisher.Pdf

Namespace
OfficeIMO.Publisher.Pdf
Assembly
OfficeIMO.Publisher.Pdf
Source revision
0eef6a5756b9 with working tree changes
Modifiers
static

Page-preserving PDF conversion of recovered Publisher publications. Source recovery losses are carried into the report.

Inheritance

  • object
  • PublisherPdfConversionExtensions

Methods

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

Writes a PDF file and returns the complete conversion report.

Parameters

document OfficeIMO.Publisher.PublisherDocument required
path string required
options OfficeIMO.Publisher.Pdf.PublisherPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

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

Parameters

document OfficeIMO.Publisher.PublisherDocument required
stream System.IO.Stream required
options OfficeIMO.Publisher.Pdf.PublisherPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

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

Parameters

document OfficeIMO.Publisher.PublisherDocument required
path string required
options OfficeIMO.Publisher.Pdf.PublisherPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

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

Parameters

document OfficeIMO.Publisher.PublisherDocument required
stream System.IO.Stream required
options OfficeIMO.Publisher.Pdf.PublisherPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Converts a Publisher document to a PDF model.

Parameters

document OfficeIMO.Publisher.PublisherDocument required
options OfficeIMO.Publisher.Pdf.PublisherPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Converts a Publisher document and returns its completed conversion findings.

Parameters

document OfficeIMO.Publisher.PublisherDocument required
options OfficeIMO.Publisher.Pdf.PublisherPdfExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Converts a Publisher document, returning the model and report together.

Parameters

document OfficeIMO.Publisher.PublisherDocument required
options OfficeIMO.Publisher.Pdf.PublisherPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<PdfDocument>>