Encapsulates the object that represents a cell comment. More...

Inherits Object.

Public Member Functions
virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetAuthor ()=0
	Gets Name of the original comment author More...

virtual void	SetAuthor (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Sets Name of the original comment author More...

virtual intrusive_ptr< Aspose::Cells::Drawing::ICommentShape >	GetICommentShape ()=0
	Get a Shape object that represents the shape attached to the specified comment. More...

virtual Aspose::Cells::Systems::Int32	GetRow ()=0
	Gets the row index of the comment. More...

virtual Aspose::Cells::Systems::Int32	GetColumn ()=0
	Gets the column index of the comment. More...

virtual bool	IsThreadedComment ()=0
	Indicates whether this comment is a threaded comment. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetNote ()=0
	Represents the content of comment. More...

virtual void	SetNote (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Represents the content of comment. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetHtmlNote ()=0
	Gets the html string which contains data and some formats in this comment. More...

virtual void	SetHtmlNote (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Sets the html string which contains data and some formats in this comment. More...

virtual intrusive_ptr< Aspose::Cells::IFont >	GetIFont ()=0
	Gets the font of comment. More...

virtual void	FormatCharactersByIFont (Aspose::Cells::Systems::Int32 startIndex, Aspose::Cells::Systems::Int32 length, intrusive_ptr< Aspose::Cells::IFont > font, intrusive_ptr< Aspose::Cells::IStyleFlag > flag)=0
	Format some characters with the font setting. More...

virtual intrusive_ptr< Aspose::Cells::IFontSetting >	GetCharacters (Aspose::Cells::Systems::Int32 startIndex, Aspose::Cells::Systems::Int32 length)=0
	Returns a Characters object that represents a range of characters within the comment text. More...

virtual intrusive_ptr< Aspose::Cells::Systems::Collections::ArrayList >	GetCharacters ()=0
	Returns all Characters objects that represents a range of characters within the comment text. More...

virtual bool	IsVisible ()=0
	Represents if the comment is visible or not. More...

virtual void	SetVisible (bool value)=0
	Represents if the comment is visible or not. More...

virtual Aspose::Cells::TextOrientationType	GetTextOrientationType ()=0
	Gets the text orientation type of the comment. More...

virtual void	SetTextOrientationType (Aspose::Cells::TextOrientationType value)=0
	Sets the text orientation type of the comment. More...

virtual Aspose::Cells::TextAlignmentType	GetTextHorizontalAlignment ()=0
	Gets the text horizontal alignment type of the comment. More...

virtual void	SetTextHorizontalAlignment (Aspose::Cells::TextAlignmentType value)=0
	Sets the text horizontal alignment type of the comment. More...

virtual Aspose::Cells::TextAlignmentType	GetTextVerticalAlignment ()=0
	Gets the text vertical alignment type of the comment. More...

virtual void	SetTextVerticalAlignment (Aspose::Cells::TextAlignmentType value)=0
	Sets the text vertical alignment type of the comment. More...

virtual bool	GetAutoSize ()=0
	Indicates if size of comment is adjusted automatically according to its content. More...

virtual void	SetAutoSize (bool value)=0
	Indicates if size of comment is adjusted automatically according to its content. More...

virtual Aspose::Cells::Systems::Double	GetHeightCM ()=0
	Represents the height of the comment, in unit of centimeters. More...

virtual void	SetHeightCM (Aspose::Cells::Systems::Double value)=0
	Represents the height of the comment, in unit of centimeters. More...

virtual Aspose::Cells::Systems::Double	GetWidthCM ()=0
	Represents the width of the comment, in unit of centimeters. More...

virtual void	SetWidthCM (Aspose::Cells::Systems::Double value)=0
	Represents the width of the comment, in unit of centimeters. More...

virtual Aspose::Cells::Systems::Int32	GetWidth ()=0
	Represents the width of the comment, in unit of pixels. More...

virtual void	SetWidth (Aspose::Cells::Systems::Int32 value)=0
	Represents the width of the comment, in unit of pixels. More...

virtual Aspose::Cells::Systems::Int32	GetHeight ()=0
	Represents the Height of the comment, in unit of pixels. More...

virtual void	SetHeight (Aspose::Cells::Systems::Int32 value)=0
	Represents the Height of the comment, in unit of pixels. More...

virtual Aspose::Cells::Systems::Double	GetWidthInch ()=0
	Represents the width of the comment, in unit of inches. More...

virtual void	SetWidthInch (Aspose::Cells::Systems::Double value)=0
	Represents the width of the comment, in unit of inches. More...

virtual Aspose::Cells::Systems::Double	GetHeightInch ()=0
	Represents the height of the comment, in unit of inches. More...

virtual void	SetHeightInch (Aspose::Cells::Systems::Double value)=0
	Represents the height of the comment, in unit of inches. More...

Detailed Description

Encapsulates the object that represents a cell comment.

Member Function Documentation

◆ FormatCharactersByIFont()

virtual void Aspose::Cells::IComment::FormatCharactersByIFont	(	Aspose::Cells::Systems::Int32	startIndex,
		Aspose::Cells::Systems::Int32	length,
		intrusive_ptr< Aspose::Cells::IFont >	font,
		intrusive_ptr< Aspose::Cells::IStyleFlag >	flag
	)

pure virtual

Format some characters with the font setting.

Parameters

startIndex	The start index.
length	The length.
font	The font setting.
flag	The flag of the font setting.

◆ GetAuthor()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IComment::GetAuthor ( )

pure virtual

Gets Name of the original comment author

◆ GetAutoSize()

virtual bool Aspose::Cells::IComment::GetAutoSize ( )

pure virtual

Indicates if size of comment is adjusted automatically according to its content.

◆ GetCharacters() [1/2]

virtual intrusive_ptr<Aspose::Cells::IFontSetting> Aspose::Cells::IComment::GetCharacters	(	Aspose::Cells::Systems::Int32	startIndex,
		Aspose::Cells::Systems::Int32	length
	)

pure virtual

Returns a Characters object that represents a range of characters within the comment text.

Parameters

startIndex	The index of the start of the character.
length	The number of characters.

Returns: Characters object.

◆ GetCharacters() [2/2]

virtual intrusive_ptr<Aspose::Cells::Systems::Collections::ArrayList> Aspose::Cells::IComment::GetCharacters ( )

pure virtual

Returns all Characters objects that represents a range of characters within the comment text.

Returns: All Characters objects

◆ GetColumn()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IComment::GetColumn ( )

pure virtual

Gets the column index of the comment.

◆ GetHeight()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IComment::GetHeight ( )

pure virtual

Represents the Height of the comment, in unit of pixels.

◆ GetHeightCM()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IComment::GetHeightCM ( )

pure virtual

Represents the height of the comment, in unit of centimeters.

◆ GetHeightInch()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IComment::GetHeightInch ( )

pure virtual

Represents the height of the comment, in unit of inches.

◆ GetHtmlNote()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IComment::GetHtmlNote ( )

pure virtual

Gets the html string which contains data and some formats in this comment.

If this is a threaded comment, the note could not be changed, otherwise MS Excel could not process it as a threaded comment.

◆ GetICommentShape()

virtual intrusive_ptr<Aspose::Cells::Drawing::ICommentShape> Aspose::Cells::IComment::GetICommentShape ( )

pure virtual

Get a Shape object that represents the shape attached to the specified comment.

◆ GetIFont()

virtual intrusive_ptr<Aspose::Cells::IFont> Aspose::Cells::IComment::GetIFont ( )

pure virtual

Gets the font of comment.

◆ GetNote()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IComment::GetNote ( )

pure virtual

Represents the content of comment.

If this is a threaded comment, the note could not be changed, otherwise MS Excel could not process it as a threaded comment.

◆ GetRow()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IComment::GetRow ( )

pure virtual

Gets the row index of the comment.

◆ GetTextHorizontalAlignment()

virtual Aspose::Cells::TextAlignmentType Aspose::Cells::IComment::GetTextHorizontalAlignment ( )

pure virtual

Gets the text horizontal alignment type of the comment.

◆ GetTextOrientationType()

virtual Aspose::Cells::TextOrientationType Aspose::Cells::IComment::GetTextOrientationType ( )

pure virtual

Gets the text orientation type of the comment.

◆ GetTextVerticalAlignment()

virtual Aspose::Cells::TextAlignmentType Aspose::Cells::IComment::GetTextVerticalAlignment ( )

pure virtual

Gets the text vertical alignment type of the comment.

◆ GetWidth()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IComment::GetWidth ( )

pure virtual

Represents the width of the comment, in unit of pixels.

◆ GetWidthCM()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IComment::GetWidthCM ( )

pure virtual

Represents the width of the comment, in unit of centimeters.

◆ GetWidthInch()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IComment::GetWidthInch ( )

pure virtual

Represents the width of the comment, in unit of inches.

◆ IsThreadedComment()

virtual bool Aspose::Cells::IComment::IsThreadedComment ( )

pure virtual

Indicates whether this comment is a threaded comment.

◆ IsVisible()

virtual bool Aspose::Cells::IComment::IsVisible ( )

pure virtual

Represents if the comment is visible or not.

◆ SetAuthor()

virtual void Aspose::Cells::IComment::SetAuthor ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Sets Name of the original comment author

◆ SetAutoSize()

virtual void Aspose::Cells::IComment::SetAutoSize ( bool value )

pure virtual

Indicates if size of comment is adjusted automatically according to its content.

◆ SetHeight()

virtual void Aspose::Cells::IComment::SetHeight ( Aspose::Cells::Systems::Int32 value )

pure virtual

Represents the Height of the comment, in unit of pixels.

◆ SetHeightCM()

virtual void Aspose::Cells::IComment::SetHeightCM ( Aspose::Cells::Systems::Double value )

pure virtual

Represents the height of the comment, in unit of centimeters.

◆ SetHeightInch()

virtual void Aspose::Cells::IComment::SetHeightInch ( Aspose::Cells::Systems::Double value )

pure virtual

Represents the height of the comment, in unit of inches.

◆ SetHtmlNote()

virtual void Aspose::Cells::IComment::SetHtmlNote ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Sets the html string which contains data and some formats in this comment.

If this is a threaded comment, the note could not be changed, otherwise MS Excel could not process it as a threaded comment.

◆ SetNote()

virtual void Aspose::Cells::IComment::SetNote ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Represents the content of comment.

If this is a threaded comment, the note could not be changed, otherwise MS Excel could not process it as a threaded comment.

◆ SetTextHorizontalAlignment()

virtual void Aspose::Cells::IComment::SetTextHorizontalAlignment ( Aspose::Cells::TextAlignmentType value )

pure virtual

Sets the text horizontal alignment type of the comment.

◆ SetTextOrientationType()

virtual void Aspose::Cells::IComment::SetTextOrientationType ( Aspose::Cells::TextOrientationType value )

pure virtual

Sets the text orientation type of the comment.

◆ SetTextVerticalAlignment()

virtual void Aspose::Cells::IComment::SetTextVerticalAlignment ( Aspose::Cells::TextAlignmentType value )

pure virtual

Sets the text vertical alignment type of the comment.

◆ SetVisible()

virtual void Aspose::Cells::IComment::SetVisible ( bool value )

pure virtual

Represents if the comment is visible or not.

◆ SetWidth()

virtual void Aspose::Cells::IComment::SetWidth ( Aspose::Cells::Systems::Int32 value )

pure virtual

Represents the width of the comment, in unit of pixels.

◆ SetWidthCM()

virtual void Aspose::Cells::IComment::SetWidthCM ( Aspose::Cells::Systems::Double value )

pure virtual

Represents the width of the comment, in unit of centimeters.

◆ SetWidthInch()

virtual void Aspose::Cells::IComment::SetWidthInch ( Aspose::Cells::Systems::Double value )

pure virtual

Represents the width of the comment, in unit of inches.

Public Member Functions

Detailed Description

Member Function Documentation

◆ FormatCharactersByIFont()

◆ GetAuthor()

◆ GetAutoSize()

◆ GetCharacters() [1/2]

◆ GetCharacters() [2/2]

◆ GetColumn()

◆ GetHeight()

◆ GetHeightCM()

◆ GetHeightInch()

◆ GetHtmlNote()

◆ GetICommentShape()

◆ GetIFont()

◆ GetNote()

◆ GetRow()

◆ GetTextHorizontalAlignment()

◆ GetTextOrientationType()

◆ GetTextVerticalAlignment()

◆ GetWidth()

◆ GetWidthCM()

◆ GetWidthInch()

◆ IsThreadedComment()

◆ IsVisible()

◆ SetAuthor()

◆ SetAutoSize()

◆ SetHeight()

◆ SetHeightCM()

◆ SetHeightInch()

◆ SetHtmlNote()

◆ SetNote()

◆ SetTextHorizontalAlignment()

◆ SetTextOrientationType()

◆ SetTextVerticalAlignment()

◆ SetVisible()

◆ SetWidth()

◆ SetWidthCM()

◆ SetWidthInch()