Class DocxReviewReport

Namespace

DocToolkit

Assembly

DocToolkit.Docx.dll

What a document carries from having been through review.

public sealed class DocxReviewReport

Inheritance

object

DocxReviewReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

One report rather than separate reads, because the underlying walk computes comments and revisions together — two calls could return counts that disagree because they came from different passes over the same document.

Properties

CommentThreadCount

Comment threads, counting a comment and its replies as one. Equal to Comments.Count; both are kept because the counts below are what a caller usually wants and reading them should not require walking the list.

public int CommentThreadCount { get; }

Property Value

int

Comments

The comments that start a thread, in document order. A reply is not listed here; it appears on its parent's Replies, so no comment is reported twice.

public IReadOnlyList<DocxComment> Comments { get; }

Property Value

IReadOnlyList<DocxComment>

Revisions

Every tracked change, in document order.

public IReadOnlyList<DocxRevision> Revisions { get; }

Property Value

IReadOnlyList<DocxRevision>

UnresolvedThreadCount

Threads nobody has marked resolved — the number worth acting on, and the reason to prefer this over a bare comment count when deciding whether a document is finished with.

public int UnresolvedThreadCount { get; }

Property Value

int