Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

PdfTextRedlineResult

OfficeIMO.Pdf

Namespace
OfficeIMO.Pdf
Assembly
OfficeIMO.Pdf
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Result of PdfTextRedline.Compare.

Inheritance

  • object
  • PdfTextRedlineResult

Usage

Explore 2 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 2

Methods

public string ToHtml(string? title = null, CancellationToken cancellationToken = default) #

Renders a standalone side-by-side HTML report of the two texts with the change list.

Parameters

title string? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

string
public string ToJson(bool indented = true) #

Serialises the change list to JSON.

Parameters

indented bool = true optional

Returns

string

Properties

public byte[] Pdf { get; } #

The new PDF with review annotations added. When nothing changed it is an unmodified copy of the new PDF.

public OfficeChangeSet Changes { get; } #

Every change, with page numbers and page rectangles on both sides.

public int AnnotationCount { get; } #

Number of annotations added (pop-ups not counted).

public bool AnnotationLimitReached { get; } #

True when PdfTextRedlineOptions.MaxAnnotatedChanges left some changes without annotations.

public string OldText { get; } #

Old PDF text in reading order, one extracted line per line.

public string NewText { get; } #

New PDF text in reading order, one extracted line per line.

public bool HasChanges { get; } #

True when the texts are the same.