Back to all docs
API Reference / Telerik.Windows.Documents.Spreadsheet.Model.Comments / CommentCollection
New to Telerik UI for WinForms? Start a free 30-day trial

CommentCollection

Class

Manages threaded comments in a worksheet, supporting add, remove, and lookup operations by cell index.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model.Comments

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:
C#
public class CommentCollection : FilteredShapeCollection<SpreadsheetComment>, IEnumerable

Inheritance: objectFilteredShapeCollection<SpreadsheetComment>CommentCollection

Implements: IEnumerable

Inherited Members FilteredShapeCollection<SpreadsheetComment>.Contains(SpreadsheetComment)FilteredShapeCollection<SpreadsheetComment>.IndexOf(SpreadsheetComment)FilteredShapeCollection<SpreadsheetComment>.Clear()FilteredShapeCollection<SpreadsheetComment>.GetEnumerator()FilteredShapeCollection<SpreadsheetComment>.GetZIndex(SpreadsheetComment)FilteredShapeCollection<SpreadsheetComment>.Add(SpreadsheetComment)FilteredShapeCollection<SpreadsheetComment>.OnItemAdding(SpreadsheetComment, out ShapeCollectionChangingEventArgs<SpreadsheetComment>)FilteredShapeCollection<SpreadsheetComment>.OnItemRemoving(SpreadsheetComment, out ShapeCollectionChangingEventArgs<SpreadsheetComment>)FilteredShapeCollection<SpreadsheetComment>.OnChanging(ShapeCollectionChangingEventArgs<SpreadsheetComment>)FilteredShapeCollection<SpreadsheetComment>.OnChanged(ShapeCollectionChangedEventArgs<SpreadsheetComment>)FilteredShapeCollection<SpreadsheetComment>.CountFilteredShapeCollection<SpreadsheetComment>.this[int]FilteredShapeCollection<SpreadsheetComment>.WorksheetFilteredShapeCollection<SpreadsheetComment>.ChangingFilteredShapeCollection<SpreadsheetComment>.Changed...

Properties

ShapeType

The shape type discriminator identifying this collection as containing comment shapes.

C#
public override FloatingShapeType ShapeType { get; }

Overrides: FilteredShapeCollection<SpreadsheetComment>.ShapeType

Methods

Add(CellIndex, string, string, DateTime?)

Creates and adds a new comment to the specified cell with author and text content.

C#
public SpreadsheetComment Add(CellIndex relatedCellIndex, string author, string text, DateTime? creationDate = null)
Parameters:relatedCellIndexCellIndex

Index of the cell assigned to the comment.

authorstring

The author.

textstring

The text.

creationDateDateTime?

The date the comment is created.

Returns:

SpreadsheetComment

The new comment.

Remove(SpreadsheetComment)

Removes the specified comment and its fallback note from the worksheet.

C#
public override bool Remove(SpreadsheetComment item)
Parameters:itemSpreadsheetComment

The comment.

Returns:

bool

The value indicating whether the specified comment was found.

Overrides: FilteredShapeCollection<SpreadsheetComment>.Remove(SpreadsheetComment)

In this article
DefinitionPropertiesShapeTypeMethodsAdd(CellIndex, string, string, DateTime?)Remove(SpreadsheetComment)
Not finding the help you need?
Contact Support