[]
        
(Showing Draft Content)

ICommentsThreaded

Interface ICommentsThreaded

All Superinterfaces:
Iterable<ICommentThreaded>

public interface ICommentsThreaded extends Iterable<ICommentThreaded>
A collection of top-level threaded comment objects in a worksheet, or a collection of replies in a single threaded comment.

Each threaded comment is represented by an ICommentThreaded object. Use IWorksheet.getCommentsThreaded() to access all threaded comments in a worksheet, or ICommentThreaded.getReplies() to access the replies of a specific threaded comment.


 ICommentThreaded comment = worksheet.getRange("C3").addCommentThreaded("Check the sales total.", "Nancy");
 comment.addReply("I updated the number.", "Bill");

 ICommentsThreaded commentsThreaded = worksheet.getCommentsThreaded();
 ICommentsThreaded replies = comment.getReplies();
 ICommentThreaded firstReply = replies.get(0);
 
  • Method Summary

    Modifier and Type
    Method
    Description
    get(int index)
    Gets the threaded comment at the specified index.
    int
    Gets the number of threaded comments in the collection.

    Methods inherited from interface java.lang.Iterable

    forEach, iterator, spliterator
  • Method Details

    • get

      ICommentThreaded get(int index)
      Gets the threaded comment at the specified index.

      This collection can represent either all top-level threaded comments in a worksheet or the replies of a single ICommentThreaded.

      
       ICommentThreaded comment = worksheet.getRange("C3").addCommentThreaded("Check the sales total.", "Nancy");
       comment.addReply("I updated the number.", "Bill");
       ICommentsThreaded replies = comment.getReplies();
       ICommentThreaded firstReply = replies.get(0);
       
      Parameters:
      index - The zero-based index of the threaded comment in the collection.
      Returns:
      The ICommentThreaded object at the specified index.
    • getCount

      int getCount()
      Gets the number of threaded comments in the collection.

      This collection can represent either all top-level threaded comments in a worksheet or the replies of a single ICommentThreaded. The returned value reflects the number of items in the current collection.

      
       ICommentThreaded comment = worksheet.getRange("A1").addCommentThreaded("Please review the total.", "Alex");
       comment.addReply("I updated the number.", "Jamie");
       ICommentsThreaded replies = comment.getReplies();
       int count = replies.getCount();
       
      Returns:
      The number of threaded comments in the collection.