Class SpreadsheetComment

Threaded comment attached to a worksheet cell, supporting author attribution, replies, creation dates, and resolution state.

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

Syntax

public class SpreadsheetComment : FloatingShapeBase, ICopyable<FloatingShapeBase>, IFloatingCommentMutable, IFloatingComment, IThreadedComment, ITextObject

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
System.String

The author.
Implements

CreationDate

Date when the comment was created; setting a new value pushes the change to the undo stack.

Declaration
public DateTime? CreationDate { get; set; }
Property Value
System.Nullable<System.DateTime>

FloatingShapeType

Returns FloatingShapeType.Comment to identify this shape as a comment.

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

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
System.Boolean

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
CellIndex

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
ReplySortedCollection

Text

Text content of the comment; setting a new value pushes the change to the undo stack.

Declaration
public string Text { get; set; }
Property Value
System.String

The text value.
Implements

Methods

AddReply(String, String, Nullable<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 = default(DateTime? ))
Parameters
System.String authorName

The author`s name.
System.String text

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

The date the reply is created.
Returns
SpreadsheetCommentReply

The new reply.

Equals(Object)

Determines whether the specified System.Object is equal to this comment by comparing base properties, author, and creation date.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with the current System.Object.
Returns
System.Boolean

True if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Computes a hash code combining base properties, author display name, and creation date.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

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
SpreadsheetCommentReply reply

The reply.
Returns
System.Boolean

The value indicating whether the specified reply was found.