CommentCollection
CommentCollection class
Encapsulates a collection of Comment objects.
Properties
| Name | Type | Description |
|---|---|---|
| Count | int | |
| Item (int) | Comment | Gets the Comment element at the specified index. |
| Item (java.lang.String) | Comment | Gets the Comment element at the specified cell. |
| Item (int, int) | Comment | Gets the Comment element at the specified row index and column index. |
Methods
| Name | Description |
|---|---|
| addThreadedComment | Adds a threaded comment. |
| getThreadedComments | Gets the threaded comments by row and column index. |
| add | Adds a comment to the collection. |
| removeAt | Removes the comment of the specific cell. |
| clear | Removes all comments; |
| iterator | |
| get | Reserved for internal use. |
| contains | Reserved for internal use. |
| indexOf | Reserved for internal use. |
CommentCollection.Count property
Type: int
CommentCollection.Item (int) property
Gets the Comment element at the specified index.
Type: Comment
CommentCollection.Item (java.lang.String) property
Gets the Comment element at the specified cell.
Type: Comment
CommentCollection.Item (int, int) property
Gets the Comment element at the specified row index and column index.
Type: Comment
addThreadedComment(row, column, text, author) (1 of 2)
Adds a threaded comment.
| Parameter | Type | Description |
|---|---|---|
| row | int | Cell row index. |
| column | int | Cell column index. |
| text | String | The text of the comment |
| author | ThreadedCommentAuthor | The user of this threaded comment. |
Returns: ThreadedComment object index.
addThreadedComment(cellName, text, author) (2 of 2)
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: ThreadedComment object index.
getThreadedComments(row, column) (1 of 2)
Gets the threaded comments by row and column index.
| Parameter | Type | Description |
|---|---|---|
| row | int | The row index. |
| column | int | The column index. |
getThreadedComments(cellName) (2 of 2)
Gets the threaded comments by cell name.
| Parameter | Type | Description |
|---|---|---|
| cellName | String | The name of the cell. |
add(row, column) (1 of 3)
Adds a comment to the collection.
| Parameter | Type | Description |
|---|---|---|
| row | int | Cell row index. |
| column | int | Cell column index. |
Returns: Comment object index.
add(cellName) (2 of 3)
Adds a comment to the collection.
| Parameter | Type | Description |
|---|---|---|
| cellName | String | Cell name. |
Returns: Comment object index.
add(value) (3 of 3)
Reserved for internal use.
removeAt(cellName) (1 of 3)
Removes the comment of the specific cell.
| Parameter | Type | Description |
|---|---|---|
| cellName | String | The name of cell which contains a comment. |
removeAt(row, column) (2 of 3)
Removes the comment of the specific cell.
| Parameter | Type | Description |
|---|---|---|
| row | int | The row index. |
| column | int | the column index. |
removeAt(index) (3 of 3)
clear()
Removes all comments;
iterator()
get(index)
Reserved for internal use.
contains(value)
Reserved for internal use.
indexOf(value)
Reserved for internal use.