asposecells.api
Class CommentCollection

Encapsulates a collection of Comment objects.

Example:

workbook = Workbook()
comments = workbook.getWorksheets().get(0).getComments()

Property Getters/Setters Summary
methodgetCount()
          
methodget(index)
           Gets the Comment element at the specified index.
methodget(row, column)
           Gets the Comment element at the specified row index and column index.
methodget(cellName)
           Gets the Comment element at the specified cell.
 
Method Summary
methodadd(row, column)
           Adds a comment to the collection.
methodadd(value)→ inherited from CollectionBase
          Reserved for internal use.
methodadd(cellName)
           Adds a comment to the collection.
methodaddThreadedComment(row, column, text, author)
           Adds a threaded comment.
methodaddThreadedComment(cellName, text, author)
           Adds a threaded comment.
methodclear()
           Removes all comments;
methodcontains(value)→ inherited from CollectionBase
          Reserved for internal use.
methodget(index)→ inherited from CollectionBase
          Reserved for internal use.
methodgetThreadedComments(row, column)
           Gets the threaded comments by row and column index.
methodgetThreadedComments(cellName)
           Gets the threaded comments by cell name.
methodindexOf(value)→ inherited from CollectionBase
          Reserved for internal use.
methoditerator()→ inherited from CollectionBase
          
methodremoveAt(index)→ inherited from CollectionBase
          
methodremoveAt(row, column)
           Removes the comment of the specific cell.
methodremoveAt(cellName)
           Removes the comment of the specific cell.
 

Property Getters/Setters Detail

getCount : int 

int getCount()

get : Comment 

Comment get(index)
Gets the Comment element at the specified index.
Parameters:
index - The zero based index of the element.
Returns:
The element at the specified index.

get : Comment 

Comment get(cellName)
Gets the Comment element at the specified cell.
Parameters:
cellName - Cell name.
Returns:
The element at the specified cell.

get : Comment 

Comment get(row, column)
Gets the Comment element at the specified row index and column index.
Parameters:
row - Row index.
column - Column index.
Returns:
The element at the specified cell.

Method Detail

addThreadedComment

int addThreadedComment(row, column, text, author)
Adds a threaded comment.
Parameters:
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

int addThreadedComment(cellName, text, author)
Adds a threaded comment.
Parameters:
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

ThreadedCommentCollection getThreadedComments(row, column)
Gets the threaded comments by row and column index.
Parameters:
row: int - The row index.
column: int - The column index.
Returns:

getThreadedComments

ThreadedCommentCollection getThreadedComments(cellName)
Gets the threaded comments by cell name.
Parameters:
cellName: String - The name of the cell.
Returns:

add

int add(row, column)
Adds a comment to the collection.
Parameters:
row: int - Cell row index.
column: int - Cell column index.
Returns:
Comment object index.

add

int add(cellName)
Adds a comment to the collection.
Parameters:
cellName: String - Cell name.
Returns:
Comment object index.

removeAt

 removeAt(cellName)
Removes the comment of the specific cell.
Parameters:
cellName: String - The name of cell which contains a comment.

removeAt

 removeAt(row, column)
Removes the comment of the specific cell.
Parameters:
row: int - The row index.
column: int - the column index.

clear

 clear()
Removes all comments;

removeAt

 removeAt(index)

iterator

Iterator iterator()

get

Object get(index)
Reserved for internal use.

contains

boolean contains(value)
Reserved for internal use.

add

int add(value)
Reserved for internal use.

indexOf

int indexOf(value)
Reserved for internal use.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.