New to Telerik Document ProcessingStart a free 30-day trial

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

Definition

Methods

Adds a new reply to this comment with the specified author, text, and optional creation date, returning the created reply.

C#
public SpreadsheetCommentReply AddReply(string authorName, string text, DateTime? creationDate = null)
Parameters:authorNamestring

The author`s name.

textstring

The text.

creationDateDateTime?

The date the reply is created.

Returns:

SpreadsheetCommentReply

The new reply.

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

C#
public override bool Equals(object obj)
Parameters:objobject

The object to compare with the current object.

Returns:

bool

True if the specified object is equal to the current object; otherwise, false.

Overrides: object.Equals(object)

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

C#
public override int GetHashCode()
Returns:

int

A hash code for the current object.

Overrides: object.GetHashCode()

Removes the specified reply from this comment's reply collection and returns true if the reply was found and removed.

C#
public bool RemoveReply(SpreadsheetCommentReply reply)
Parameters:replySpreadsheetCommentReply

The reply.

Returns:

bool

The value indicating whether the specified reply was found.

Properties

Display name of the comment's author; setting a new value pushes the change to the undo stack.

C#
public string Author { get; set; }
Property Value:

The author.

Implements: IFloatingComment.Author

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

C#
public DateTime? CreationDate { get; set; }

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

C#
public override FloatingShapeType FloatingShapeType { get; }

Overrides: FloatingShapeBase.FloatingShapeType

Indicates whether the comment thread is resolved; setting a new value pushes the change to the undo stack.

C#
public bool IsResolved { get; set; }
Property Value:

The value indicating whether the comment is resolved.

Cell index to which this comment is attached; setting a new value pushes the change to the undo stack.

C#
public CellIndex RelatedCellIndex { get; set; }
Property Value:

The cell index.

Implements: IFloatingCommentMutable.RelatedCellIndexIFloatingComment.RelatedCellIndex

Collection of replies to this comment, sorted by creation date in ascending order.

C#
public ReplySortedCollection Replies { get; }

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

C#
public string Text { get; set; }
Property Value:

The text value.

Implements: IFloatingComment.Text