ClassCommentCollection
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:
public class CommentCollection : FilteredShapeCollection<SpreadsheetComment>, IEnumerable<SpreadsheetComment>, IEnumerableInheritance: objectFilteredShapeCollection<SpreadsheetComment>CommentCollection
Implements:
Inherited Members
Properties
ShapeType
The shape type discriminator identifying this collection as containing comment shapes.
Declaration
public override FloatingShapeType ShapeType { get; }Property Value
Overrides
Methods
Add(CellIndex, string, string, DateTime?)
Creates and adds a new comment to the specified cell with author and text content.
Declaration
public SpreadsheetComment Add(CellIndex relatedCellIndex, string author, string text, DateTime? creationDate = null)Parameters
relatedCellIndex
Index of the cell assigned to the comment.
author
The author.
text
The text.
creationDate
The date the comment is created.
Returns
The new comment.
Remove(SpreadsheetComment)
Removes the specified comment and its fallback note from the worksheet.
Declaration
public override bool Remove(SpreadsheetComment item)Parameters
item
The comment.
Returns
The value indicating whether the specified comment was found.
Overrides