Class

PdfDocumentProof

OfficeIMO.Pdf

Edit on GitHub

Namespace: OfficeIMO.Pdf
Assembly: OfficeIMO.Pdf
Source revision: ac7e6e1bad8a with working tree changes
Source: PdfDocumentProof.cs:12
Modifiers: sealed

Visual and structural preservation proof operations for one PDF document.

Inheritance

object
PdfDocumentProof

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

Property PdfDocument.Proof

Methods

public PdfPageChangeReport AnalyzePageChanges(PdfDocument actualDocument, PdfPageChangeOptions? options = null, CancellationToken cancellationToken = default)

PdfDocumentProof.cs:16

Aligns pages with another PDF and reports insertion, deletion, reorder, and visual-change candidates.

Parameters

actualDocument OfficeIMO.Pdf.PdfDocument required
options OfficeIMO.Pdf.PdfPageChangeOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

PdfPageChangeReport

AssertRewritePreservationMatrix 3 overloads

public PdfRewritePreservationMatrixReport AssertRewritePreservationMatrix(string id, string operation, Func<PdfDocument, PdfDocument> rewrite, PdfRewritePreservationOptions? options = null)

PdfDocumentProof.cs:93

Asserts one rewrite scenario using the default rewrite-safe expectation.

Parameters

id string required
operation string required
rewrite System.Func<OfficeIMO.Pdf.PdfDocument, OfficeIMO.Pdf.PdfDocument> required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? = null optional

Returns

PdfRewritePreservationMatrixReport

public PdfRewritePreservationMatrixReport AssertRewritePreservationMatrix(string id, string operation, Func<PdfDocument, PdfDocument> rewrite, PdfRewritePreservationOptions? options, IEnumerable<string>? sourceFeatures)

PdfDocumentProof.cs:97

Asserts one rewrite scenario with source feature labels.

Parameters

id string required
operation string required
rewrite System.Func<OfficeIMO.Pdf.PdfDocument, OfficeIMO.Pdf.PdfDocument> required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? required
sourceFeatures System.Collections.Generic.IEnumerable<string>? required

Returns

PdfRewritePreservationMatrixReport

public PdfRewritePreservationMatrixReport AssertRewritePreservationMatrix(string id, string operation, Func<PdfDocument, PdfDocument> rewrite, PdfRewritePreservationMatrixClassification expectedClassification, PdfRewritePreservationOptions? options = null, IEnumerable<string>? sourceFeatures = null)

PdfDocumentProof.cs:101

Asserts one rewrite scenario against an explicit expected classification.

Parameters

id string required
operation string required
rewrite System.Func<OfficeIMO.Pdf.PdfDocument, OfficeIMO.Pdf.PdfDocument> required
expectedClassification OfficeIMO.Pdf.PdfRewritePreservationMatrixClassification required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? = null optional
sourceFeatures System.Collections.Generic.IEnumerable<string>? = null optional

Returns

PdfRewritePreservationMatrixReport

AssertRewritePreserved 4 overloads

public PdfRewritePreservationReport AssertRewritePreserved(PdfDocument rewrittenDocument, PdfRewritePreservationOptions? options = null)

PdfDocumentProof.cs:65

Asserts structural preservation against a rewritten document.

Parameters

rewrittenDocument OfficeIMO.Pdf.PdfDocument required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? = null optional

Returns

PdfRewritePreservationReport

public PdfRewritePreservationReport AssertRewritePreserved(byte[] rewrittenPdf, PdfRewritePreservationOptions? options = null)

PdfDocumentProof.cs:69

Asserts structural preservation against rewritten bytes.

Parameters

rewrittenPdf byte[] required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? = null optional

Returns

PdfRewritePreservationReport

public PdfRewritePreservationReport AssertRewritePreserved(Stream rewrittenStream, PdfRewritePreservationOptions? options = null)

PdfDocumentProof.cs:73

Asserts structural preservation against a rewritten stream.

Parameters

rewrittenStream System.IO.Stream required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? = null optional

Returns

PdfRewritePreservationReport

public PdfRewritePreservationReport AssertRewritePreserved(string rewrittenPath, PdfRewritePreservationOptions? options = null)

PdfDocumentProof.cs:77

Asserts structural preservation against a rewritten file.

Parameters

rewrittenPath string required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? = null optional

Returns

PdfRewritePreservationReport

AssessRewritePreservation 4 overloads

public PdfRewritePreservationReport AssessRewritePreservation(PdfDocument rewrittenDocument, PdfRewritePreservationOptions? options = null)

PdfDocumentProof.cs:49

Assesses structural preservation against a rewritten document.

Parameters

rewrittenDocument OfficeIMO.Pdf.PdfDocument required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? = null optional

Returns

PdfRewritePreservationReport

public PdfRewritePreservationReport AssessRewritePreservation(byte[] rewrittenPdf, PdfRewritePreservationOptions? options = null)

PdfDocumentProof.cs:53

Assesses structural preservation against rewritten bytes.

Parameters

rewrittenPdf byte[] required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? = null optional

Returns

PdfRewritePreservationReport

public PdfRewritePreservationReport AssessRewritePreservation(Stream rewrittenStream, PdfRewritePreservationOptions? options = null)

PdfDocumentProof.cs:57

Assesses structural preservation against a rewritten stream.

Parameters

rewrittenStream System.IO.Stream required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? = null optional

Returns

PdfRewritePreservationReport

public PdfRewritePreservationReport AssessRewritePreservation(string rewrittenPath, PdfRewritePreservationOptions? options = null)

PdfDocumentProof.cs:61

Assesses structural preservation against a rewritten file.

Parameters

rewrittenPath string required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? = null optional

Returns

PdfRewritePreservationReport

AssessRewritePreservationMatrix 3 overloads

public PdfRewritePreservationMatrixReport AssessRewritePreservationMatrix(string id, string operation, Func<PdfDocument, PdfDocument> rewrite, PdfRewritePreservationOptions? options = null)

PdfDocumentProof.cs:81

Assesses one rewrite scenario using the default rewrite-safe expectation.

Parameters

id string required
operation string required
rewrite System.Func<OfficeIMO.Pdf.PdfDocument, OfficeIMO.Pdf.PdfDocument> required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? = null optional

Returns

PdfRewritePreservationMatrixReport

public PdfRewritePreservationMatrixReport AssessRewritePreservationMatrix(string id, string operation, Func<PdfDocument, PdfDocument> rewrite, PdfRewritePreservationOptions? options, IEnumerable<string>? sourceFeatures)

PdfDocumentProof.cs:85

Assesses one rewrite scenario with source feature labels.

Parameters

id string required
operation string required
rewrite System.Func<OfficeIMO.Pdf.PdfDocument, OfficeIMO.Pdf.PdfDocument> required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? required
sourceFeatures System.Collections.Generic.IEnumerable<string>? required

Returns

PdfRewritePreservationMatrixReport

public PdfRewritePreservationMatrixReport AssessRewritePreservationMatrix(string id, string operation, Func<PdfDocument, PdfDocument> rewrite, PdfRewritePreservationMatrixClassification expectedClassification, PdfRewritePreservationOptions? options = null, IEnumerable<string>? sourceFeatures = null)

PdfDocumentProof.cs:89

Assesses one rewrite scenario against an explicit expected classification.

Parameters

id string required
operation string required
rewrite System.Func<OfficeIMO.Pdf.PdfDocument, OfficeIMO.Pdf.PdfDocument> required
expectedClassification OfficeIMO.Pdf.PdfRewritePreservationMatrixClassification required
options OfficeIMO.Pdf.PdfRewritePreservationOptions? = null optional
sourceFeatures System.Collections.Generic.IEnumerable<string>? = null optional

Returns

PdfRewritePreservationMatrixReport

public PdfReviewComparisonReport CompareReview(PdfDocument actualDocument, PdfReviewComparisonOptions? options = null, CancellationToken cancellationToken = default)

PdfDocumentProof.cs:33

Aligns pages and classifies supported text, image, scan, and visual differences for review.

Parameters

actualDocument OfficeIMO.Pdf.PdfDocument required
options OfficeIMO.Pdf.PdfReviewComparisonOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

PdfReviewComparisonReport

CompareVisual 3 overloads

public PdfVisualComparisonReport CompareVisual(byte[] actualPdf, PdfPageSelection? selection = null, PdfVisualComparisonOptions? options = null, PdfLoadOptions? actualReadOptions = null)

PdfDocumentProof.cs:37

Compares this document with PDF bytes through the managed renderer.

Parameters

actualPdf byte[] required
selection OfficeIMO.Pdf.PdfPageSelection? = null optional
options OfficeIMO.Pdf.PdfVisualComparisonOptions? = null optional
actualReadOptions OfficeIMO.Pdf.PdfLoadOptions? = null optional

Returns

PdfVisualComparisonReport

public PdfVisualComparisonReport CompareVisual(PdfDocument actualDocument, PdfPageSelection? selection = null, PdfVisualComparisonOptions? options = null)

PdfDocumentProof.cs:41

Compares this document with another PDF through the managed renderer.

Parameters

actualDocument OfficeIMO.Pdf.PdfDocument required
selection OfficeIMO.Pdf.PdfPageSelection? = null optional
options OfficeIMO.Pdf.PdfVisualComparisonOptions? = null optional

Returns

PdfVisualComparisonReport

public PdfVisualComparisonReport CompareVisual(PdfDocument actualDocument, CancellationToken cancellationToken, PdfPageSelection? selection = null, PdfVisualComparisonOptions? options = null)

PdfDocumentProof.cs:45

Compares authenticated document snapshots with cooperative cancellation and bounded rendered artifacts.

Parameters

actualDocument OfficeIMO.Pdf.PdfDocument required
cancellationToken System.Threading.CancellationToken required
selection OfficeIMO.Pdf.PdfPageSelection? = null optional
options OfficeIMO.Pdf.PdfVisualComparisonOptions? = null optional

Returns

PdfVisualComparisonReport

public PdfVisualPageComparison CompareVisualPages(int expectedPageNumber, PdfDocument actualDocument, int actualPageNumber, PdfVisualComparisonOptions? options = null, CancellationToken cancellationToken = default)

PdfDocumentProof.cs:24

Renders and compares an aligned page pair from two documents.

Parameters

expectedPageNumber int required
actualDocument OfficeIMO.Pdf.PdfDocument required
actualPageNumber int required
options OfficeIMO.Pdf.PdfVisualComparisonOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

PdfVisualPageComparison

public PdfProductionPreflightReport PreflightProduction(PdfProductionPreflightOptions? options = null, CancellationToken cancellationToken = default)

PdfDocumentProof.cs:12

Inspects production-readiness evidence and proposes reviewable page-box metadata fixups.

Parameters

options OfficeIMO.Pdf.PdfProductionPreflightOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

PdfProductionPreflightReport

Search OfficeIMO

PdfDocumentProof

Inheritance

Usage

Returned or exposed by 1

Methods

Inherited Methods