ClassSpreadsheetComment
Threaded comment attached to a worksheet cell, supporting author attribution, replies, creation dates, and resolution state.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Model.Comments
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public class SpreadsheetComment : FloatingShapeBase, IFloatingCommentMutable, IFloatingComment
Inheritance: objectFloatingShapeBaseSpreadsheetComment
Implements:
Inherited Members
Properties
Author
Display name of the comment's author; setting a new value pushes the change to the undo stack.
Declaration
public string Author { get; set; }
Property Value
The author.
Implements
CreationDate
Date when the comment was created; setting a new value pushes the change to the undo stack.
FloatingShapeType
Returns FloatingShapeType.Comment to identify this shape as a comment.
Declaration
public override FloatingShapeType FloatingShapeType { get; }
Property Value
Overrides
IsResolved
Indicates whether the comment thread is resolved; setting a new value pushes the change to the undo stack.
Declaration
public bool IsResolved { get; set; }
Property Value
The value indicating whether the comment is resolved.
RelatedCellIndex
Cell index to which this comment is attached; setting a new value pushes the change to the undo stack.
Declaration
public CellIndex RelatedCellIndex { get; set; }
Property Value
The cell index.
Implements
Replies
Collection of replies to this comment, sorted by creation date in ascending order.
Declaration
public ReplySortedCollection Replies { get; }
Property Value
Methods
AddReply(string, string, DateTime?)
Adds a new reply to this comment with the specified author, text, and optional creation date, returning the created reply.
Declaration
public SpreadsheetCommentReply AddReply(string authorName, string text, DateTime? creationDate = null)
Parameters
authorName
The author`s name.
text
The text.
creationDate
The date the reply is created.
Returns
The new reply.
Equals(object)
Determines whether the specified object is equal to this comment by comparing base properties, author, and creation date.
GetHashCode()
Computes a hash code combining base properties, author display name, and creation date.
RemoveReply(SpreadsheetCommentReply)
Removes the specified reply from this comment's reply collection and returns true if the reply was found and removed.
Declaration
public bool RemoveReply(SpreadsheetCommentReply reply)
Parameters
reply
The reply.
Returns
The value indicating whether the specified reply was found.