com.grapecity.documents.excel

Interface IComment

public interface IComment

Represents a cell comment.

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the object.
void	fromJson(java.lang.String json) Generates the comment from the json string.
IRange	getAnchorCell() Gets the anchor cell of the comment.
java.lang.String	getAuthor() Gets the author of the comment.
IShape	getShape() Returns the IShape object that represents the shape attached to the specified comment.
java.lang.String	getText() Gets the comment text.
boolean	getVisible() Determines whether the object is visible.
IComment	next() Returns the IComment object that represents the next comment.
IComment	previous() Returns the IComment object that represents the previous comment.
void	setText(java.lang.String value) Sets the comment text.
void	setVisible(boolean value) Determines whether the object is visible.
java.lang.String	toJson() Generates a json string from the comment.

Method Detail

getText

java.lang.String getText()

Gets the comment text.

setText

void setText(java.lang.String value)

Sets the comment text.

getAuthor

java.lang.String getAuthor()

Gets the author of the comment.

getAnchorCell

IRange getAnchorCell()

Gets the anchor cell of the comment.

delete

void delete()

Deletes the object.

next

IComment next()

Returns the IComment object that represents the next comment.

previous

IComment previous()

Returns the IComment object that represents the previous comment.

getVisible

boolean getVisible()

Determines whether the object is visible.

setVisible

void setVisible(boolean value)

Determines whether the object is visible.

getShape

IShape getShape()

Returns the IShape object that represents the shape attached to the specified comment.

fromJson

void fromJson(java.lang.String json)

Generates the comment from the json string.

Parameters:

json - the json string that contains comment info

toJson

java.lang.String toJson()

Generates a json string from the comment.

Returns:

the json string that contains comment info