Get Started

API Reference

Class

PdfSaveResult

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Core/PdfSaveResult.cs:61
Modifiers sealed

Result returned by file and stream output operations.

Inheritance

  • Object
  • PdfSaveResult

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

Methods

public static PdfSaveResult FromFailure(String outputPath, Exception exception) #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:78
Returns: PdfSaveResult

Creates a failed save result from an exception captured by a wrapper or adapter.

Parameters

outputPath System.String requiredposition: 0
exception System.Exception requiredposition: 1
public static PdfSaveResult FromSuccess(String outputPath, Int64 bytesWritten) #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:73
Returns: PdfSaveResult

Creates a successful save result.

Parameters

outputPath System.String requiredposition: 0
bytesWritten System.Int64 requiredposition: 1
public PdfSaveResult RequireSuccess() #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:61
Returns: PdfSaveResult

Returns this result or throws with diagnostics when the save failed.

Properties

public Boolean Succeeded { get; } #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:27

True when the save operation completed.

public String OutputPath { get; } #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:30

Full output path when the operation targeted a file path.

public Int64 BytesWritten { get; } #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:33

Number of bytes written when the operation completed; otherwise 0.

public IReadOnlyList<String> Diagnostics { get; } #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:36

Human-readable diagnostics explaining why the save failed.

public Exception Exception { get; } #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:39

Exception captured from the save attempt, when available.

public IReadOnlyList<PdfTextEncodingDiagnostic> TextEncodingDiagnostics { get; } #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:42

Structured text encoding diagnostics captured from PDF generation failures.

public PdfConversionReport Report { get; } #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:45

Snapshot of source-conversion and structured output warnings for this save attempt.

public PdfPipelineReport Pipeline { get; } #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:48

End-to-end create/open, mutation, and output evidence for this save attempt.

public PdfSerializationReport Serialization { get; } #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:51

Bounded serialization evidence for a successful save, when available.

public IReadOnlyList<PdfConversionWarning> Warnings { get; } #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:54

Source-conversion and structured output warnings for this save attempt.

public Boolean HasWarnings { get; } #
OfficeIMO.Pdf/Core/PdfSaveResult.cs:57

True when source conversion or PDF output produced a warning.