com.aspose.cells
Class CommentCollection

java.lang.Object
  CollectionBase
      com.aspose.cells.CommentCollection

All Implemented Interfaces:

java.lang.Iterable

public class CommentCollection 
extends CollectionBase

Workbook workbook = new Workbook();

CommentCollection comments = workbook.getWorksheets().get(0).getComments();

//do your business

public int getCount()

public Comment get(int 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.

Example:

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

public Comment get(java.lang.String cellName)

Gets the Comment element at the specified cell.

Parameters:

cellName - Cell name.

Returns:

The element at the specified cell.

Example:

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

public Comment get(int row, int 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.

Example:

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

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.

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.

public ThreadedCommentCollection getThreadedComments(int row, int column)

Gets the threaded comments by row and column index.

Parameters:

row - The row index.

column - The column index.

Returns:

Example:

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

public ThreadedCommentCollection getThreadedComments(java.lang.String cellName)

Gets the threaded comments by cell name.

Parameters:

cellName - The name of the cell.

Returns:

Example:

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

public int add(int row, int column)

Adds a comment to the collection.

Parameters:

row - Cell row index.

column - Cell column index.

Returns:

Comment object index.

Example:

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

public int add(java.lang.String cellName)

Adds a comment to the collection.

Parameters:

cellName - Cell name.

Returns:

Comment object index.

Example:

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

public void removeAt(java.lang.String cellName)

Removes the comment of the specific cell.

Parameters:

cellName - The name of cell which contains a comment.

Example:

comments.removeAt("B2");

public void removeAt(int row, int column)

Removes the comment of the specific cell.

Parameters:

row - The row index.

column - the column index.

Example:

comments.removeAt(1,1);

public void clear()

Removes all comments;

Example:

comments.clear();

public void removeAt(int index)

public java.util.Iterator iterator()

public boolean contains(java.lang.Object value)

Reserved for internal use.

public int add(java.lang.Object value)

Reserved for internal use.

public int indexOf(java.lang.Object value)

Reserved for internal use.