Aspose::Cells::ICommentCollection Class Reference

Encapsulates a collection of IComment objects. More...

Inherits CollectionBase.

Public Member Functions
virtual Aspose::Cells::Systems::Int32	Add (Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column)=0
	Adds a comment to the collection. More...
virtual Aspose::Cells::Systems::Int32	Add (intrusive_ptr< Aspose::Cells::Systems::String > cellName)=0
	Adds a comment to the collection. More...
virtual intrusive_ptr< Aspose::Cells::IComment >	GetObjectByIndex (Aspose::Cells::Systems::Int32 index)=0
	Gets the IComment element at the specified index. More...
virtual intrusive_ptr< Aspose::Cells::IComment >	GetObjectByIndex (intrusive_ptr< Aspose::Cells::Systems::String > cellName)=0
	Gets the IComment element at the specified cell. More...
virtual intrusive_ptr< Aspose::Cells::IComment >	GetObjectByIndex (Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column)=0
	Gets the IComment element at the specified row index and column index. More...
virtual void	RemoveAt (intrusive_ptr< Aspose::Cells::Systems::String > cellName)=0
	Removes the comment of the specific cell. More...
virtual void	RemoveAt (Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column)=0
	Removes the comment of the specific cell. More...
virtual void	Clear ()=0
	Removes all comments; More...

Detailed Description

Encapsulates a collection of IComment objects.

Member Function Documentation

Add() [1/2]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::ICommentCollection::Add ( Aspose::Cells::Systems::Int32  row, Aspose::Cells::Systems::Int32  column  )

pure virtual

Adds a comment to the collection.

Parameters

row	Cell row index.
column	Cell column index.

Returns

IComment object index.

Add() [2/2]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::ICommentCollection::Add ( intrusive_ptr< Aspose::Cells::Systems::String >  cellName )

pure virtual

Adds a comment to the collection.

Parameters

cellName

Cell name.

Returns

IComment object index.

Clear()

virtual void Aspose::Cells::ICommentCollection::Clear ( )

pure virtual

Removes all comments;

GetObjectByIndex() [1/3]

virtual intrusive_ptr<Aspose::Cells::IComment> Aspose::Cells::ICommentCollection::GetObjectByIndex ( Aspose::Cells::Systems::Int32  index )

pure virtual

Gets the IComment element at the specified index.

Parameters

index

The zero based index of the element.

Returns

The element at the specified index.

GetObjectByIndex() [2/3]

virtual intrusive_ptr<Aspose::Cells::IComment> Aspose::Cells::ICommentCollection::GetObjectByIndex ( intrusive_ptr< Aspose::Cells::Systems::String >  cellName )

pure virtual

Gets the IComment element at the specified cell.

Parameters

cellName

Cell name.

Returns

The element at the specified cell.

GetObjectByIndex() [3/3]

virtual intrusive_ptr<Aspose::Cells::IComment> Aspose::Cells::ICommentCollection::GetObjectByIndex ( Aspose::Cells::Systems::Int32  row, Aspose::Cells::Systems::Int32  column  )

pure virtual

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

Parameters

row	Row index.
column	Column index.

Returns

The element at the specified cell.

RemoveAt() [1/2]

virtual void Aspose::Cells::ICommentCollection::RemoveAt ( intrusive_ptr< Aspose::Cells::Systems::String >  cellName )

pure virtual

Removes the comment of the specific cell.

Parameters

cellName

The name of cell which contains a comment.

RemoveAt() [2/2]

virtual void Aspose::Cells::ICommentCollection::RemoveAt ( Aspose::Cells::Systems::Int32  row, Aspose::Cells::Systems::Int32  column  )

pure virtual

Removes the comment of the specific cell.

Parameters

row	The row index.
column	the column index.