API Reference

Class

WordReviewReport

Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Modifiers sealed

Summarizes comments, tracked revisions, unsupported review metadata, and optional accept/reject actions.

Inheritance

  • Object
  • WordReviewReport

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

Methods

public static WordReviewReport From(WordReviewInfo review, params WordRevisionOperationReport[] actions) #
Returns: WordReviewReport

Creates a review report from an existing review read model.

Parameters

review OfficeIMO.Word.WordReviewInfo requiredposition: 0
Review metadata returned by InspectReview.
actions OfficeIMO.Word.WordRevisionOperationReport[] requiredposition: 1
Optional accept/reject operation reports to include.
public String ToJson() #
Returns: String

Serializes this report to deterministic JSON.

public String ToMarkdown() #
Returns: String

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

Properties

public IReadOnlyList<WordCommentInfo> Comments { get; } #

Gets all parsed comments in deterministic document order.

public IReadOnlyList<WordCommentThreadInfo> CommentThreads { get; } #

Gets top-level comments grouped with their replies.

public IReadOnlyList<WordRevisionInfo> Revisions { get; } #

Gets parsed tracked revisions in deterministic document order.

public IReadOnlyList<String> UnsupportedMetadata { get; } #

Gets detected modern review metadata that OfficeIMO preserves but does not fully parse yet.

public IReadOnlyList<WordRevisionOperationReport> Actions { get; } #

Gets accept/reject operation reports supplied by the caller.

public IReadOnlyList<WordCommentInfo> UnresolvedThreads { get; } #

Gets comments that are known unresolved or do not expose resolved metadata.

public IReadOnlyList<WordCommentThreadInfo> UnresolvedCommentThreads { get; } #

Gets grouped comment threads that are known unresolved or do not expose resolved metadata.

public Int32 CommentCount { get; } #

Gets the number of parsed comments.

public Int32 CommentThreadCount { get; } #

Gets the number of top-level comment threads.

public Int32 RevisionCount { get; } #

Gets the number of parsed tracked revisions.

public Int32 UnresolvedThreadCount { get; } #

Gets the number of unresolved top-level comment threads.

public Int32 ActionCount { get; } #

Gets the number of supplied accept/reject action reports.

public Int32 UnsupportedMetadataCount { get; } #

Gets the number of detected unsupported review metadata entries.