com.aspose.cells

Class CommentCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.CommentCollection

All Implemented Interfaces:

java.lang.Iterable

public class CommentCollection
extends CollectionBase

Encapsulates a collection of Comment objects.

Example

 
         Workbook workbook = new Workbook();
 
         CommentCollection comments = workbook.getWorksheets().get(0).getComments();
 
         //do your business
 

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int row, int column) Adds a comment to the collection.
int	add(java.lang.String cellName) Adds a comment to the collection.
int	addThreadedComment(int row, int column, java.lang.String text, ThreadedCommentAuthor author) Adds a threaded comment.
int	addThreadedComment(java.lang.String cellName, java.lang.String text, ThreadedCommentAuthor author) Adds a threaded comment.
void	clear() Removes all comments;
Comment	get(int index) Gets the Comment element at the specified index.
Comment	get(int row, int column) Gets the Comment element at the specified row index and column index.
Comment	get(java.lang.String cellName) Gets the Comment element at the specified cell.
ThreadedCommentCollection	getThreadedComments(int row, int column) Gets the threaded comments by row and column index.
ThreadedCommentCollection	getThreadedComments(java.lang.String cellName) Gets the threaded comments by cell name.
void	removeAt(int row, int column) Removes the comment of the specific cell.
void	removeAt(java.lang.String cellName) Removes the comment of the specific cell.

Methods inherited from class com.aspose.cells.CollectionBase

add, contains, getCount, indexOf, iterator, removeAt

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addThreadedComment

public int addThreadedComment(int row,
                     int column,
                     java.lang.String text,
                     ThreadedCommentAuthor author)

Adds a threaded comment.

Parameters:

row - Cell row index.

column - Cell column index.

text - The text of the comment

author - The user of this threaded comment.

Returns:

ThreadedComment object index.

addThreadedComment

public int addThreadedComment(java.lang.String cellName,
                     java.lang.String text,
                     ThreadedCommentAuthor author)

Adds a threaded comment.

Parameters:

cellName - The name of the cell.

text - The text of the comment

author - The user of this threaded comment.

Returns:

ThreadedComment object index.

getThreadedComments

public ThreadedCommentCollection getThreadedComments(int row,
                                            int column)

Gets the threaded comments by row and column index.

Example

 
         ThreadedCommentCollection threadedComments1 = comments.getThreadedComments(1, 1);
         for (int i = 0; i <threadedComments1.getCount(); ++i)
         {
             ThreadedComment tc = threadedComments1.get(i);
             String note = tc.getNotes();
         }
 

Parameters:

row - The row index.

column - The column index.

Returns:

getThreadedComments

public ThreadedCommentCollection getThreadedComments(java.lang.String cellName)

Gets the threaded comments by cell name.

Example

 
         ThreadedCommentCollection threadedComments2 = comments.getThreadedComments("B2");
         for (int i = 0; i <threadedComments2.getCount(); ++i)
         {
             ThreadedComment tc = threadedComments2.get(i);
             String note = tc.getNotes();
         }
 

Parameters:

cellName - The name of the cell.

Returns:

add

public int add(int row,
      int column)

Adds a comment to the collection.

Example

 
         int commentIndex1 = comments.add(0, 0);
         Comment comment1 = comments.get(commentIndex1);
         comment1.setNote("First note.");
         comment1.getFont().setName("Times New Roman");
 

Parameters:

row - Cell row index.

column - Cell column index.

Returns:

Comment object index.

add

public int add(java.lang.String cellName)

Adds a comment to the collection.

Example

 
         int commentIndex2 = comments.add("B2");
         Comment comment2 = comments.get(commentIndex2);
         comment2.setNote("Second note.");
         comment2.getFont().setName("Times New Roman");
 

Parameters:

cellName - Cell name.

Returns:

Comment object index.

get

public Comment get(int index)

Gets the Comment element at the specified index.

Example

 
         Comment comment3 = comments.get(0);
         comment3.setNote("Three note.");
 

Overrides:

get in class CollectionBase

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

get

public Comment get(java.lang.String cellName)

Gets the Comment element at the specified cell.

Example

 
         Comment comment4 = comments.get("B2");
         comment4.setNote("Four note.");
 

Parameters:

cellName - Cell name.

Returns:

The element at the specified cell.

get

public Comment get(int row,
          int column)

Gets the Comment element at the specified row index and column index.

Example

 
         Comment comment5 = comments.get(1,1);
         comment5.setNote("Five note.");
 

Parameters:

row - Row index.

column - Column index.

Returns:

The element at the specified cell.

removeAt

public void removeAt(java.lang.String cellName)

Removes the comment of the specific cell.

Example

 
         comments.removeAt("B2");
 

Parameters:

cellName - The name of cell which contains a comment.

removeAt

public void removeAt(int row,
            int column)

Removes the comment of the specific cell.

Example

 
         comments.removeAt(1,1);
 

Parameters:

row - The row index.

column - the column index.

clear

public void clear()

Removes all comments;

Example

 
         comments.clear();
 

Overrides:

clear in class CollectionBase