Documentation

Class CommentCollection

Represents a collection of comments.

Inheritance
System.Object
FilteredShapeCollection<SpreadsheetComment>
CommentCollection
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model.Comments
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class CommentCollection : FilteredShapeCollection<SpreadsheetComment>, IEnumerable<SpreadsheetComment>, IEnumerable

Properties

ShapeType

Gets the type of the shape.

Declaration
public override FloatingShapeType ShapeType { get; }
Property Value
FloatingShapeType

Overrides
Telerik.Windows.Documents.Spreadsheet.Model.FilteredShapeCollection<Telerik.Windows.Documents.Spreadsheet.Model.Comments.SpreadsheetComment>.ShapeType

Methods

Add(CellIndex, String, String, Nullable<DateTime>)

Adds a new comment to the collection.

Declaration
public SpreadsheetComment Add(CellIndex relatedCellIndex, string author, string text, DateTime? creationDate = default(DateTime? ))
Parameters
CellIndex relatedCellIndex

Index of the cell assigned to the comment.
System.String author

The author.
System.String text

The text.
System.Nullable<System.DateTime> creationDate

The date the comment is created.
Returns
SpreadsheetComment

The new comment.

Remove(SpreadsheetComment)

Removes the specified comment from the collection.

Declaration
public override bool Remove(SpreadsheetComment item)
Parameters
SpreadsheetComment item

The comment.
Returns
System.Boolean

The value indicating whether the specified comment was found.
Overrides
Telerik.Windows.Documents.Spreadsheet.Model.FilteredShapeCollection<Telerik.Windows.Documents.Spreadsheet.Model.Comments.SpreadsheetComment>.Remove(Telerik.Windows.Documents.Spreadsheet.Model.Comments.SpreadsheetComment)