Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

PdfAConversionResult

OfficeIMO.Pdf

Namespace
OfficeIMO.Pdf
Assembly
OfficeIMO.Pdf
Source revision
0eef6a5756b9 with working tree changes
Implements
IOfficeResult<PdfDocument> IOfficeResult
Modifiers
sealed

The PDF/A file produced by conversion, or the report of why the source was refused.

Inheritance

  • object
  • PdfAConversionResult

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Methods

public PdfDocument RequireValue() #

Returns the converted document, or throws PdfAConversionException listing every violation.

Save 2 overloads
public void Save(Stream stream, CancellationToken cancellationToken = default) #

Writes the converted file to a caller-owned stream, or throws PdfAConversionException without writing to it.

Parameters

stream System.IO.Stream required
cancellationToken System.Threading.CancellationToken = default optional
public void Save(string path, CancellationToken cancellationToken = default) #

Writes the converted file, or throws PdfAConversionException without creating path.

Parameters

path string required
cancellationToken System.Threading.CancellationToken = default optional
public byte[] ToBytes() #

Returns a copy of the converted bytes, or throws PdfAConversionException listing every violation.

Returns

byte[]

Properties

public bool Succeeded { get; } #

Gets whether conversion produced a file. When false, PdfAConversionReport.Violations lists every reason.

public PdfAConversionReport Report { get; } #

Gets the changes made, or the reasons the source was refused.

public PdfDocument? Value { get; } #

Gets the converted document, or null when conversion was refused.