Class
SpreadsheetComment

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

Definition

Properties

Author

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

Declaration

cs-api-definition
public string Author { get; set; }

Property Value

string

The author.

Implements IFloatingComment.Author

CreationDate

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

Declaration

cs-api-definition
public DateTime? CreationDate { get; set; }

Property Value

DateTime?

FloatingShapeType

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

Declaration

cs-api-definition
public override FloatingShapeType FloatingShapeType { get; }

Property Value

FloatingShapeType

Overrides FloatingShapeBase.FloatingShapeType

IsResolved

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

Declaration

cs-api-definition
public bool IsResolved { get; set; }

Property Value

bool

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

cs-api-definition
public CellIndex RelatedCellIndex { get; set; }

Property Value

CellIndex

The cell index.

Implements IFloatingCommentMutable.RelatedCellIndexIFloatingComment.RelatedCellIndex

Replies

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

Declaration

cs-api-definition
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

cs-api-definition
public string Text { get; set; }

Property Value

string

The text value.

Implements IFloatingComment.Text

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

cs-api-definition
public SpreadsheetCommentReply AddReply(string authorName, string text, DateTime? creationDate = null)

Parameters

authorName

string

The author`s name.

text

string

The text.

creationDate

DateTime?

The date the reply is created.

Returns

SpreadsheetCommentReply

The new reply.

Equals(object)

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

Declaration

cs-api-definition
public override bool Equals(object obj)

Parameters

obj

object

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)

GetHashCode()

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

Declaration

cs-api-definition
public override int GetHashCode()

Returns

int

A hash code for the current object.

Overrides 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

cs-api-definition
public bool RemoveReply(SpreadsheetCommentReply reply)

Parameters

reply

SpreadsheetCommentReply

The reply.

Returns

bool

The value indicating whether the specified reply was found.