Package com.grapecity.documents.excel

Interface ICommentThreaded

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

  • Method Summary

    Modifier and Type
    Method
    Description
    ICommentThreaded
    addReply(String text)
    Adds a reply to its replies collection if the threaded comment is a top-level comment.
    ICommentThreaded
    addReply(String text, String author)
    Adds a reply to its replies collection if the threaded comment is a top-level comment.
    void
    delete()
    Deletes the specified threaded comment and all replies associated with that comment.
    IAuthor
    getAuthor()
    Gets the author object of the threaded comment.
    Date
    getDate()
    Deprecated.
    This member is obsolete.
    boolean
    getIsResolved()
    Gets the resolve value.
    LocalDateTime
    getLocalDateTime()
    Returns a date that represents the date and time that a threaded comment was added in local time.
    ICommentThreaded
    getParent()
    Returns the parent object for the specified object.
    ICommentsThreaded
    getReplies()
    Returns a CommentsThreaded collection of CommentThreaded objects that are replies if the specified comment.
    String
    getText()
    Gets the threaded comment's text.
    ICommentThreaded
    next()
    Returns the ICommentThreaded object that represents the next threaded comment.Returns null if the top-level threaded comment is the last threaded comment on a sheet.
    ICommentThreaded
    previous()
    Returns the ICommentThreaded object that represents the previous threaded comment.Returns null if the top-level threaded comment is the first threaded comment on a sheet.
    void
    setIsResolved(boolean value)
    Makes the threaded comment impossible to edit and reply.
    void
    setText(String text)
    Sets the threaded comment's text.

  • Method Details

    • addReply

      ICommentThreaded addReply(String text)
      Adds a reply to its replies collection if the threaded comment is a top-level comment. If this threaded comment is a reply,it will add a reply to its Parent's replies collection.
      Parameters:
      text - The string is content of the reply.

    • addReply

      ICommentThreaded addReply(String text, String author)
      Adds a reply to its replies collection if the threaded comment is a top-level comment. If this threaded comment is a reply,it will add a reply to its Parent's replies collection.
      Parameters:
      text - The string is content of the reply.
      author - The author of the reply.

    • delete

      void delete()
      Deletes the specified threaded comment and all replies associated with that comment. If threaded comment is a reply, delete itself from the parent's reply list.

    • setIsResolved

      void setIsResolved(boolean value)
      Makes the threaded comment impossible to edit and reply.

    • getIsResolved

      boolean getIsResolved()
      Gets the resolve value.

    • getText

      String getText()
      Gets the threaded comment's text.

    • setText

      void setText(String text)
      Sets the threaded comment's text.

    • getReplies

      ICommentsThreaded getReplies()
      Returns a CommentsThreaded collection of CommentThreaded objects that are replies if the specified comment. The replies are sorted by time stamp. If this threaded comment is a reply,returns an empty collection.

    • getAuthor

      IAuthor getAuthor()
      Gets the author object of the threaded comment.

    • getDate

      @Deprecated Date getDate()
      Deprecated.
      This member is obsolete. Use getLocalDateTime() instead.
      Returns a date that represents the date and time that a threaded comment was added in local time.

    • getLocalDateTime

      LocalDateTime getLocalDateTime()
      Returns a date that represents the date and time that a threaded comment was added in local time.

    • next

      ICommentThreaded next()
      Returns the ICommentThreaded object that represents the next threaded comment.Returns null if the top-level threaded comment is the last threaded comment on a sheet. Returns null if the reply threaded comment is the last reply of a threaded comment's replies.

    • previous

      ICommentThreaded previous()
      Returns the ICommentThreaded object that represents the previous threaded comment.Returns null if the top-level threaded comment is the first threaded comment on a sheet. Returns null if the reply threaded comment is the first reply of a threaded comment's replies.

    • getParent

      ICommentThreaded getParent()
      Returns the parent object for the specified object. The top-level threaded comment's parent is null.