API Reference
PdfDocumentConversionResult
Result of a source-document to PDF conversion, pairing the generated PDF document with a snapshot of conversion diagnostics.
Inheritance
- Object
- PdfDocumentConversionResult
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
Accepted by parameters
- Extension method PdfDocumentConversionResult.ExportImages
- Extension method PdfDocumentConversionResult.ToImages
- Extension method PdfDocumentConversionResult.ToImages
- Method PdfImageExportExtensions.ExportImages
- Method PdfImageExportExtensions.ToImages
- Method PdfImageExportExtensions.ToImages
Constructors
public PdfDocumentConversionResult(PdfDocument document, PdfConversionReport conversionReport) #Creates a conversion result from a generated PDF document and the conversion report populated during export.
Parameters
- document OfficeIMO.Pdf.PdfDocument
- conversionReport OfficeIMO.Pdf.PdfConversionReport
Methods
public PdfConversionProofReport AssertProof(PdfConversionProofOptions options = null) #PdfConversionProofReportBuilds a conversion proof snapshot and throws when requested proof checks fail.
Parameters
- options OfficeIMO.Pdf.PdfConversionProofOptions = null
public PdfConversionProofReport AssessProof(PdfConversionProofOptions options = null) #PdfConversionProofReportBuilds a reusable proof snapshot for the generated PDF and captured conversion diagnostics.
Parameters
- options OfficeIMO.Pdf.PdfConversionProofOptions = null
public PdfDocumentConversionResult Process(Func<PdfDocument, PdfDocument> process) #PdfDocumentConversionResultApplies PDF post-processing while preserving the captured conversion diagnostics in the returned result.
Parameters
- process System.Func{OfficeIMO.Pdf.PdfDocument,OfficeIMO.Pdf.PdfDocument}
public PdfDocument RequireNoLoss() #PdfDocumentReturns the generated PDF document only when conversion reported no possible content loss.
public PdfSaveResult Save(Stream stream) #PdfSaveResultWrites the generated PDF document to the supplied stream and returns conversion plus output evidence.
Parameters
- stream System.IO.Stream
public PdfSaveResult Save(String path) #PdfSaveResultWrites the generated PDF document to the supplied file path and returns conversion plus output evidence.
Parameters
- path System.String
public async Task<PdfSaveResult> SaveAsync(Stream stream, CancellationToken cancellationToken = null) #Task<PdfSaveResult>Asynchronously writes the generated PDF document to the supplied stream and returns conversion plus output evidence.
Parameters
- stream System.IO.Stream
- cancellationToken System.Threading.CancellationToken = null
public async Task<PdfSaveResult> SaveAsync(String path, CancellationToken cancellationToken = null) #Task<PdfSaveResult>Asynchronously writes the generated PDF document to the supplied file path and returns conversion plus output evidence.
Parameters
- path System.String
- cancellationToken System.Threading.CancellationToken = null
public PdfSaveResult TrySave(Stream stream) #PdfSaveResultAttempts to write the generated PDF document to the supplied stream and returns output diagnostics instead of throwing.
Parameters
- stream System.IO.Stream
public PdfSaveResult TrySave(String path) #PdfSaveResultAttempts to write the generated PDF document to the supplied file path and returns output diagnostics instead of throwing.
Parameters
- path System.String
public Task<PdfSaveResult> TrySaveAsync(Stream stream, CancellationToken cancellationToken = null) #Task<PdfSaveResult>Attempts to asynchronously write the generated PDF document to the supplied stream and returns output diagnostics instead of throwing.
Parameters
- stream System.IO.Stream
- cancellationToken System.Threading.CancellationToken = null
public Task<PdfSaveResult> TrySaveAsync(String path, CancellationToken cancellationToken = null) #Task<PdfSaveResult>Attempts to asynchronously write the generated PDF document to the supplied file path and returns output diagnostics instead of throwing.
Parameters
- path System.String
- cancellationToken System.Threading.CancellationToken = null
public PdfDocumentConversionResult WithAdditionalWarnings(IEnumerable<PdfConversionWarning> warnings) #PdfDocumentConversionResultReturns a new conversion result that prepends adapter or source-projection warnings while retaining the original converter report as a live linked source for save-time diagnostics.
Parameters
- warnings System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfConversionWarning}
public PdfDocumentConversionResult WithValue(PdfDocument value) #PdfDocumentConversionResultReturns a new conversion result with the supplied PDF document while preserving the captured conversion diagnostics.
Parameters
- value OfficeIMO.Pdf.PdfDocument
Inherited Methods
Properties
public PdfDocument Value { get; } #The generated PDF document, ready for fluent OfficeIMO.Pdf processing.
public PdfPipelineReport Pipeline { get; } #Create/open and post-processing evidence accumulated by the generated PDF document.
public PdfConversionReport Report { get; } #Snapshot of conversion warnings captured when the result was created and refreshed after save-time diagnostics run.
public IReadOnlyList<PdfConversionWarning> Warnings { get; } #Warnings captured during conversion.
public Boolean HasWarnings { get; } #True when conversion produced at least one warning.
public Boolean HasLoss { get; } #True when conversion reported an approximation, omission, or error.
public PdfConversionReportSummary Summary { get; } #Counts grouped conversion diagnostics captured with this result.
Extension Methods
public static IReadOnlyList<OfficeImageExportResult> ExportImages(PdfDocumentConversionResult conversion, OfficeImageExportFormat format, PdfImageExportOptions options = null, PdfPageSelection selection = null, CancellationToken cancellationToken = null) #IReadOnlyList<OfficeImageExportResult>Exports pages from a source-to-PDF conversion while preserving its conversion diagnostics. This is the shared paged-image bridge for Markdown, AsciiDoc, LaTeX, RTF, OneNote, and other PDF adapters.
Parameters
- arg1 OfficeIMO.Pdf.PdfDocumentConversionResult
- arg2 OfficeIMO.Drawing.OfficeImageExportFormat
- arg3 OfficeIMO.Pdf.PdfImageExportOptions = null
- arg4 OfficeIMO.Pdf.PdfPageSelection = null
- arg5 System.Threading.CancellationToken = null
public static PdfDocumentImageExportBuilder ToImages(PdfDocumentConversionResult conversion) #PdfDocumentImageExportBuilderStarts fluent paged-image export from a source-to-PDF conversion and carries its diagnostics into every page result.
Parameters
- conversion OfficeIMO.Pdf.PdfDocumentConversionResult
public static PdfDocumentImageExportBuilder ToImages(PdfDocumentConversionResult conversion, PdfImageExportOptions options) #PdfDocumentImageExportBuilderStarts fluent paged-image export with a cloned options snapshot and retained conversion diagnostics.
Parameters
- conversion OfficeIMO.Pdf.PdfDocumentConversionResult
- options OfficeIMO.Pdf.PdfImageExportOptions