Example:
$workbook = new cells\Workbook(); $comments = $workbook->getWorksheets()->get(0)->getComments();
| Property Getters/Setters Summary | ||
|---|---|---|
function | getCount() | |
function | get(index) | |
|
Gets the |
||
function | get(row, column) | |
|
Gets the |
||
function | get(cellName) | |
|
Gets the |
||
| Method Summary | ||
|---|---|---|
function | add(row, column) | |
| Adds a comment to the collection. | ||
function | add(value) | → inherited from CollectionBase |
| Reserved for internal use. | ||
function | add(cellName) | |
| Adds a comment to the collection. | ||
function | addThreadedComment(row, column, text, author) | |
| Adds a threaded comment. | ||
function | addThreadedComment(cellName, text, author) | |
| Adds a threaded comment. | ||
function | clear() | |
| Removes all comments; | ||
function | contains(value) | → inherited from CollectionBase |
| Reserved for internal use. | ||
function | get(index) | → inherited from CollectionBase |
| Reserved for internal use. | ||
function | getThreadedComments(row, column) | |
| Gets the threaded comments by row and column index. | ||
function | getThreadedComments(cellName) | |
| Gets the threaded comments by cell name. | ||
function | indexOf(value) | → inherited from CollectionBase |
| Reserved for internal use. | ||
function | iterator() | → inherited from CollectionBase |
function | removeAt(index) | → inherited from CollectionBase |
function | removeAt(row, column) | |
| Removes the comment of the specific cell. | ||
function | removeAt(cellName) | |
| Removes the comment of the specific cell. | ||
| Property Getters/Setters Detail |
|---|
getCount : Number | |
function getCount() | |
get : Comment | |
function get(index) | |
index - The zero based index of the element.get : Comment | |
function get(cellName) | |
cellName - Cell name.get : Comment | |
function get(row, column) | |
row - Row index.column - Column index.| Method Detail |
|---|
addThreadedComment | |
function addThreadedComment(row, column, text, author) | |
row: Number - Cell row index.column: Number - Cell column index.text: String - The text of the commentauthor: ThreadedCommentAuthor - The user of this threaded comment.addThreadedComment | |
function addThreadedComment(cellName, text, author) | |
cellName: String - The name of the cell.text: String - The text of the commentauthor: ThreadedCommentAuthor - The user of this threaded comment.getThreadedComments | |
function getThreadedComments(row, column) | |
row: Number - The row index.column: Number - The column index.getThreadedComments | |
function getThreadedComments(cellName) | |
cellName: String - The name of the cell.add | |
function add(row, column) | |
row: Number - Cell row index.column: Number - Cell column index.add | |
function add(cellName) | |
cellName: String - Cell name.removeAt | |
function removeAt(cellName) | |
cellName: String - The name of cell which contains a comment.removeAt | |
function removeAt(row, column) | |
row: Number - The row index.column: Number - the column index.clear | |
function clear() | |
removeAt | |
function removeAt(index) | |
iterator | |
function iterator() | |
get | |
function get(index) | |
contains | |
function contains(value) | |
add | |
function add(value) | |
indexOf | |
function indexOf(value) | |