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