Class SpreadsheetComment

Represents a comment element in the RadSpreadsheet.

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

Gets or sets the author assigned to the comment. Setting it will push the change in the undo stack.

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

The author.
Implements

CreationDate

Gets or sets the date when the comment is created. Setting it will push the change in the undo stack.

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

FloatingShapeType

Gets the type of the shape.

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

Overrides

IsResolved

Gets or sets a value indicating whether the comment is resolved.

Declaration
public bool IsResolved { get; set; }
Property Value
System.Boolean

The value indicating whether the comment is resolved.

RelatedCellIndex

Gets or sets the cell index assigned to the comment. Setting it will push the change in the undo stack.

Declaration
public CellIndex RelatedCellIndex { get; set; }
Property Value
CellIndex

The cell index.
Implements

Replies

Gets the comment replies. The list is sorted by CreationDate.

Declaration
public ReplySortedCollection Replies { get; }
Property Value
ReplySortedCollection

Text

Gets or sets the text. Setting it will push the change in 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 the collection.

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 the current System.Object.

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()

Serves as a hash function for a particular type.

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 the collection.

Declaration
public bool RemoveReply(SpreadsheetCommentReply reply)
Parameters
SpreadsheetCommentReply reply

The reply.
Returns
System.Boolean

The value indicating whether the specified reply was found.

Extension Methods