Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 658 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Class

WordComparisonResult

OfficeIMO.Word

Edit on GitHub
Namespace
OfficeIMO.Word
Assembly
OfficeIMO.Word
Source revision
e163ccb36643 with working tree changes
Source
WordComparisonResult.cs:172
Modifiers
sealed

Machine-readable comparison result produced by WordDocumentComparer.CompareStructure.

Inheritance

  • object
  • WordComparisonResult

Guides & Samples

Authored walkthroughs and practical samples linked to this API.

  • Production Word workflows Guide

    Build template-driven DOCX files, review document changes, convert HTML and Markdown, and generate inspectable validation proof with OfficeIMO.Word.

Usage

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

Accepted by parameters 3

Methods

public string ToJson() #
WordComparisonResult.Reports.cs:9

Serializes this comparison result to deterministic JSON.

Returns

string
public string ToMarkdown() #
WordComparisonResult.Reports.cs:14

Renders this comparison result as Markdown suitable for review notes and automation logs.

Returns

string
public string ToTextSummary() #
WordComparisonResult.Reports.cs:19

Returns a compact single-line summary suitable for CLI wrappers and CI annotations.

Returns

string

Properties

public string SourcePath { get; } #
WordComparisonResult.cs:172

Source document path used for the comparison.

public string TargetPath { get; } #
WordComparisonResult.cs:175

Target document path used for the comparison.

public IReadOnlyList<WordComparisonFinding> Findings { get; } #
WordComparisonResult.cs:178

All detected findings in deterministic document order.

public bool HasChanges { get; } #
WordComparisonResult.cs:181

Gets whether any differences were detected.

public IReadOnlyList<WordComparisonLimitation> Limitations { get; } #
WordComparisonResult.cs:184

Gets stable disclosures for encountered shapes that are not compared with complete Word layout semantics.

public bool HasLimitations { get; } #
WordComparisonResult.cs:187

Gets whether comparison encountered at least one explicitly disclosed semantic boundary.