CommentCollection
CommentCollection class
Encapsulates a collection of Comment objects.
Methods
| Name | Description |
|---|---|
| add(row, column) | Adds a comment to the collection. |
| add(cellName) | Adds a comment to the collection. |
| add() | Reserved for internal use. |
| addThreadedComment(row, column, text, author) | Adds a threaded comment. |
| addThreadedComment(cellName, text, author) | Adds a threaded comment. |
| clear() | Removes all comments; |
| contains() | Reserved for internal use. |
| get(index) | Gets the Comment element at the specified index. |
| get(cellName) | Gets the Comment element at the specified cell. |
| get(row, column) | Gets the Comment element at the specified row index and column index. |
| get() | Reserved for internal use. |
| getCount() | |
| getThreadedComments(row, column) | Gets the threaded comments by row and column index. |
| getThreadedComments(cellName) | Gets the threaded comments by cell name. |
| indexOf() | Reserved for internal use. |
| iterator() | |
| removeAt(cellName) | Removes the comment of the specific cell. |
| removeAt(row, column) | Removes the comment of the specific cell. |
| removeAt() |
add(row, column)
Adds a comment to the collection.
| Parameter | Type | Description |
|---|---|---|
| row | Number | Cell row index. |
| column | Number | Cell column index. |
Returns: Number — Number Comment object index.
add(cellName)
Adds a comment to the collection.
| Parameter | Type | Description |
|---|---|---|
| cellName | String | Cell name. |
Returns: Number — Number Comment object index.
add()
Reserved for internal use.
addThreadedComment(row, column, text, author)
Adds a threaded comment.
| Parameter | Type | Description |
|---|---|---|
| row | Number | Cell row index. |
| column | Number | Cell column index. |
| text | String | The text of the comment |
| author | ThreadedCommentAuthor | The user of this threaded comment. |
Returns: Number — Number ThreadedComment object index.
addThreadedComment(cellName, text, author)
Adds a threaded comment.
| Parameter | Type | Description |
|---|---|---|
| cellName | String | The name of the cell. |
| text | String | The text of the comment |
| author | ThreadedCommentAuthor | The user of this threaded comment. |
Returns: Number — Number ThreadedComment object index.
clear()
Removes all comments;
contains()
Reserved for internal use.
get(index)
Gets the Comment element at the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | Number | The zero based index of the element. |
Returns: Comment — Comment The element at the specified index.
get(cellName)
Gets the Comment element at the specified cell.
| Parameter | Type | Description |
|---|---|---|
| cellName | String | Cell name. |
Returns: Comment — Comment The element at the specified cell.
get(row, column)
Gets the Comment element at the specified row index and column index.
| Parameter | Type | Description |
|---|---|---|
| row | Number | Row index. |
| column | Number | Column index. |
Returns: Comment — Comment The element at the specified cell.
get()
Reserved for internal use.
getCount()
getThreadedComments(row, column)
Gets the threaded comments by row and column index.
| Parameter | Type | Description |
|---|---|---|
| row | Number | The row index. |
| column | Number | The column index. |
Returns: ThreadedCommentCollection — ThreadedCommentCollection
getThreadedComments(cellName)
Gets the threaded comments by cell name.
| Parameter | Type | Description |
|---|---|---|
| cellName | String | The name of the cell. |
Returns: ThreadedCommentCollection — ThreadedCommentCollection
indexOf()
Reserved for internal use.
iterator()
removeAt(cellName)
Removes the comment of the specific cell.
| Parameter | Type | Description |
|---|---|---|
| cellName | String | The name of cell which contains a comment. |
removeAt(row, column)
Removes the comment of the specific cell.
| Parameter | Type | Description |
|---|---|---|
| row | Number | The row index. |
| column | Number | the column index. |