[]
        
(Showing Draft Content)

GrapeCity.Documents.Excel.ICommentThreaded

ICommentThreaded Interface

Represents a cell's threaded comment. This object can represent both a top-level comment or its replies.

Use this interface to read or modify threaded comment content, navigate between parent and reply comments, and work with the replies associated with a top-level comment. A threaded comment is typically created from a cell by calling AddCommentThreaded(string, string) and can also be accessed from the worksheet's ICommentsThreaded collection.

Namespace: GrapeCity.Documents.Excel
Assembly: DS.Documents.Excel.dll
Syntax
public interface ICommentThreaded
Public Interface ICommentThreaded
Examples
ICommentThreaded comment = worksheet.Range["A1"].AddCommentThreaded("Review this value", "Alex");
ICommentThreaded reply = comment.AddReply("I updated the number.", "Jamie");
ICommentThreaded parent = reply.Parent;
ICommentsThreaded replies = comment.Replies;

Properties

Name Description
Author

Gets the author object of the threaded comment.

Date

Gets the DateTime value for when the threaded comment was added in Coordinated Universal Time (UTC).

IsResolved

Gets or sets a value indicating whether the threaded comment is resolved.

Parent

Gets the parent object for the specified threaded comment.

The top-level threaded comment's parent is null. For a reply, this method returns the threaded comment that the reply belongs to.

Replies

Gets the replies of this threaded comment.

Returns a ICommentsThreaded collection that contains the ICommentThreaded objects replying to this comment. The replies are sorted by time stamp. If this threaded comment is itself a reply, this property returns null.

Text

Gets or sets the threaded comment's text.

Returns the text content of this threaded comment, whether it is a top-level comment or a reply.

Methods

Name Description
AddReply(string, string)

Adds a reply to this threaded comment.

Adds a reply to this comment's replies collection if the threaded comment is a top-level comment. If this threaded comment is a reply, it adds the new reply to the parent comment's replies collection.

When author is omitted, this method uses an empty author string.

Delete()

Deletes the specified threaded comment and all replies associated with that comment.

If this threaded comment is a reply, it deletes only itself from the parent comment's reply list.

Next()

Returns the ICommentThreaded object that represents the next threaded comment.

For a top-level threaded comment, this method returns the next threaded comment on the worksheet. For a reply threaded comment, this method returns the next reply in the parent threaded comment's replies collection.

Previous()

Returns the ICommentThreaded object that represents the previous threaded comment.

For a top-level threaded comment, this method returns the previous threaded comment on the worksheet. For a reply threaded comment, this method returns the previous reply in the parent threaded comment's replies collection.