API Reference
PdfSaveResult
Result returned by file and stream output operations.
Inheritance
- Object
- PdfSaveResult
Usage
Explore 14 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 14
- Method PdfDocument.Save
- Method PdfDocument.SaveAsync
- Method PdfDocument.SaveResult
- Method PdfDocument.SaveResultAsync
- Method PdfDocumentConversionResult.Save
- Method PdfDocumentConversionResult.SaveAsync
- Method PdfDocumentConversionResult.SaveLossless
- Method PdfDocumentConversionResult.SaveLosslessAsync
- Method PdfDocumentConversionResult.SaveResult
- Method PdfDocumentConversionResult.SaveResultAsync
- Method PdfSaveResult.FromFailure
- Method PdfSaveResult.FromSuccess
- Method PdfSaveResult.RequireNoLoss
- Method PdfSaveResult.RequireSuccess
Methods
public static PdfSaveResult FromFailure(String? outputPath, Exception exception) #PdfSaveResultCreates a failed save result from an exception captured by a wrapper or adapter.
Parameters
- outputPath System.String?
- exception System.Exception
public static PdfSaveResult FromFailure(String? outputPath, Exception exception, IOfficeConversionReport sourceConversionReport) #PdfSaveResultCreates a failed save result while retaining the source-stage report that caused the failure.
Parameters
- outputPath System.String?
- exception System.Exception
- sourceConversionReport OfficeIMO.IOfficeConversionReport
public static PdfSaveResult FromSuccess(String? outputPath, Int64 bytesWritten) #PdfSaveResultCreates a successful save result.
Parameters
- outputPath System.String?
- bytesWritten System.Int64
public PdfSaveResult RequireNoLoss() #PdfSaveResultRequires a successful save without reported conversion loss.
public PdfSaveResult RequireSuccess() #PdfSaveResultReturns this result or throws with diagnostics when the save failed.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String? OutputPath { get; } #Full output path when the operation targeted a file path.
public Int64 BytesWritten { get; } #Number of bytes written when the operation completed; otherwise 0.
public IReadOnlyList<String> Diagnostics { get; } #Human-readable diagnostics explaining why the save failed.
public Exception? Exception { get; } #Exception captured from the save attempt, when available.
public IReadOnlyList<PdfTextEncodingDiagnostic> TextEncodingDiagnostics { get; } #Structured text encoding diagnostics captured from PDF generation failures.
public PdfConversionReport Report { get; } #Snapshot of PDF-stage structured output warnings for this save attempt.
public IReadOnlyList<IOfficeConversionReport> ConversionReports { get; } #Ordered source-stage reports followed by the PDF-stage report, when conversion preceded the save.
public PdfPipelineReport Pipeline { get; } #End-to-end create/open, mutation, and output evidence for this save attempt.
public PdfSerializationReport? Serialization { get; } #Bounded serialization evidence for a successful save, when available.
public IReadOnlyList<PdfConversionWarning> Warnings { get; } #PDF-stage structured output warnings for this save attempt.
public Boolean HasWarnings { get; } #True when the PDF stage produced a structured output warning.
public Boolean HasLoss { get; } #True when any source or PDF conversion stage reported possible content loss.
public IReadOnlyList<OfficeConversionFidelityDiagnostic> FidelityDiagnostics { get; } #All source and PDF-stage diagnostics with their original loss categories preserved.