Comment class

Comment class

Encapsulates the object that represents a cell comment.

The Comment type exposes the following members:

Properties

PropertyDescription
authorGets and sets Name of the original comment author
comment_shapeGet a Shape object that represents the shape attached to the specified comment.
rowGets the row index of the comment.
columnGets the column index of the comment.
is_threaded_commentIndicates whether this comment is a threaded comment.
threaded_commentsGets the list of threaded comments;
noteRepresents the content of comment.
html_noteGets and sets the html string which contains data and some formats in this comment.
fontGets the font of comment.
is_visibleRepresents if the comment is visible or not.
text_orientation_typeGets and sets the text orientation type of the comment.
text_horizontal_alignmentGets and sets the text horizontal alignment type of the comment.
text_vertical_alignmentGets and sets the text vertical alignment type of the comment.
auto_sizeIndicates if size of comment is adjusted automatically according to its content.
height_cmRepresents the height of the comment, in unit of centimeters.
width_cmRepresents the width of the comment, in unit of centimeters.
widthRepresents the width of the comment, in unit of pixels.
heightRepresents the Height of the comment, in unit of pixels.
width_inchRepresents the width of the comment, in unit of inches.
height_inchRepresents the height of the comment, in unit of inches.

Methods

MethodDescription
format_charactersFormat some characters with the font setting.
charactersReturns a Characters object that represents a range of characters within the comment text.
get_charactersReturns all Characters objects
that represents a range of characters within the comment text.
get_rich_formattingsReturns all Characters objects
that represents a range of characters within the comment text.

See Also