API Reference

Class

PdfOptimizationActionResult

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Result of applying lossless PDF optimization actions.

Inheritance

  • Object
  • PdfOptimizationActionResult

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 PdfDocument ToDocument(PdfReadOptions readOptions = null) #
Returns: PdfDocument

Opens the selected optimized or original bytes through the fluent document API.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0

Properties

public Byte[] Bytes { get; } #

Optimized PDF bytes, or original bytes when no smaller optimized form was produced.

public Int64 OriginalLengthBytes { get; } #

Input PDF length in bytes.

public Int64 OptimizedLengthBytes { get; } #

Returned PDF length in bytes.

public Int64 CandidateLengthBytes { get; } #

Optimized candidate length before KeepOriginalWhenNotSmaller is applied.

public Int64 SavedBytes { get; } #

Bytes saved in the returned PDF.

public Int64 CandidateSavedBytes { get; } #

Bytes the optimized candidate would save before KeepOriginalWhenNotSmaller is applied.

public PdfOptimizationReport ReportBefore { get; } #

Optimization analysis collected before applying actions.

public PdfOptimizationReport ReportAfter { get; } #

Optimization analysis collected from the optimized candidate.

public IReadOnlyList<PdfOptimizationAction> Actions { get; } #

Actions applied while building the optimized candidate.

public IReadOnlyList<PdfOptimizationSkippedAction> SkippedActions { get; } #

Optimization opportunities skipped while building the candidate.

public PdfRewritePreservationReport PreservationReport { get; } #

Post-save proof that non-size document contracts were preserved.

public PdfOptimizationProfile RequestedProfile { get; } #

Named profile requested for the candidate.

public PdfOptimizationXrefFormat CandidateXrefFormat { get; } #

Cross-reference representation emitted by the candidate.

public Boolean CandidateUsesObjectStreams { get; } #

True when the candidate packs eligible objects into object streams.

public Boolean CandidateLinearized { get; } #

True when the candidate uses standards-compliant Fast Web View layout and hint tables.

public Boolean ReturnedOriginal { get; } #

True when the original bytes were returned because the optimized candidate was not smaller.

public Boolean Applied { get; } #

True when the returned bytes are smaller than the input bytes.

public Int32 ActionCount { get; } #

Number of actions applied while building the optimized candidate.

public Int32 SkippedActionCount { get; } #

Number of skipped optimization opportunities recorded while building the candidate.