Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

WordComparisonFinding

OfficeIMO.Word

Namespace
OfficeIMO.Word
Assembly
OfficeIMO.Word
Source revision
e163ccb36643 with working tree changes
Modifiers
sealed

Represents one machine-readable difference between two Word documents.

Inheritance

  • object
  • WordComparisonFinding

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

Constructors

public WordComparisonFinding(WordComparisonScope scope, WordComparisonChangeKind changeKind, string location, int? sourceIndex, int? targetIndex, string? sourceText, string? targetText, string message, string? detailedLocation = null) #

Creates a new comparison finding.

Parameters

scope OfficeIMO.Word.WordComparisonScope required
Document area where the change was found.
changeKind OfficeIMO.Word.WordComparisonChangeKind required
Kind of change found.
location string required
Stable, human-readable path such as paragraph[0] or table[1]/row[2]/cell[0].
sourceIndex int? required
Index in the source collection when available.
targetIndex int? required
Index in the target collection when available.
sourceText string? required
Source text when the finding has textual content.
targetText string? required
Target text when the finding has textual content.
message string required
Short diagnostic message suitable for logs and review reports.
detailedLocation string? = null optional
Optional richer location that includes the document part or feature context.

Properties

public WordComparisonScope Scope { get; } #

Document area where the change was found.

public WordComparisonChangeKind ChangeKind { get; } #

Kind of change found.

public string Location { get; } #

Stable, human-readable path such as paragraph[0] or table[1]/row[2]/cell[0].

public string DetailedLocation { get; } #

Richer stable path that may include the document part, package URI, or feature context.

public int? SourceIndex { get; } #

Index in the source collection when available.

public int? TargetIndex { get; } #

Index in the target collection when available.

public string? SourceText { get; } #

Source text when the finding has textual content.

public string? TargetText { get; } #

Target text when the finding has textual content.

public string Message { get; } #

Short diagnostic message suitable for logs and review reports.