API Reference
Class
WordComparisonFinding
Represents one machine-readable difference between two Word documents.
Inheritance
- Object
- WordComparisonFinding
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
- Property WordComparisonResult.Findings
Constructors
public WordComparisonFinding(WordComparisonScope scope, WordComparisonChangeKind changeKind, String location, Nullable<Int32> sourceIndex, Nullable<Int32> targetIndex, String sourceText, String targetText, String message) #Creates a new comparison finding.
Parameters
- scope OfficeIMO.Word.WordComparisonScope
- Document area where the change was found.
- changeKind OfficeIMO.Word.WordComparisonChangeKind
- Kind of change found.
- location System.String
- Stable, human-readable path such as paragraph[0] or table[1]/row[2]/cell[0].
- sourceIndex System.Nullable{System.Int32}
- Index in the source collection when available.
- targetIndex System.Nullable{System.Int32}
- Index in the target collection when available.
- sourceText System.String
- Source text when the finding has textual content.
- targetText System.String
- Target text when the finding has textual content.
- message System.String
- Short diagnostic message suitable for logs and review reports.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
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 Nullable<Int32> SourceIndex { get; } #Index in the source collection when available.
public Nullable<Int32> 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.