Class ThreadedCommentCollection

Represents the collection of threaded comments on a worksheet.

Inheritance

object

ThreadedCommentCollection

Implements

IReadOnlyCollection<ThreadedComment>

IEnumerable<ThreadedComment>

IEnumerable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DRIT.Spreadsheet

Assembly: DRIT.Spreadsheet.dll

Syntax

public class ThreadedCommentCollection : IReadOnlyCollection<ThreadedComment>, IEnumerable<ThreadedComment>, IEnumerable

Properties

Count

Gets the number of threaded comments on the worksheet.

Declaration

public int Count { get; }

Property Value

Type	Description
int

this[int]

Gets the threaded comment at the specified index.

Declaration

public ThreadedComment this[int index] { get; }

Parameters

Type	Name	Description
int	index

Property Value

Type	Description
ThreadedComment

Methods

Add(string, string, ThreadedCommentAuthor)

Adds a new top-level threaded comment anchored to the specified cell.

Declaration

public ThreadedComment Add(string cellRef, string text, ThreadedCommentAuthor author)

Parameters

Type	Name	Description
string	cellRef	The cell reference (e.g. "A1") to anchor the comment to.
string	text	The comment text.
ThreadedCommentAuthor	author	The author of the comment.

Returns

Type	Description
ThreadedComment	The newly created ThreadedComment.

AddReply(ThreadedComment, string, ThreadedCommentAuthor)

Adds a reply to an existing threaded comment.

Declaration

public ThreadedComment AddReply(ThreadedComment parent, string text, ThreadedCommentAuthor author)

Parameters

Type	Name	Description
ThreadedComment	parent	The parent comment to reply to.
string	text	The reply text.
ThreadedCommentAuthor	author	The author of the reply.

Returns

Type	Description
ThreadedComment	The newly created reply ThreadedComment.

GetByCell(string)

Gets the top-level (parent-less) threaded comments anchored to the specified cell reference.

Declaration

public IEnumerable<ThreadedComment> GetByCell(string cellRef)

Parameters

Type	Name	Description
string	cellRef

Returns

Type	Description
IEnumerable<ThreadedComment>

GetEnumerator()

Retrieves the requested enumerator from the ThreadedCommentCollection.

Declaration

public IEnumerator<ThreadedComment> GetEnumerator()

Returns

Type	Description
IEnumerator<ThreadedComment>	The get enumerator returned by the operation.

GetReplies(ThreadedComment)

Gets the replies to the specified threaded comment.

Declaration

public IEnumerable<ThreadedComment> GetReplies(ThreadedComment parent)

Parameters

Type	Name	Description
ThreadedComment	parent

Returns

Type	Description
IEnumerable<ThreadedComment>

Implements

IReadOnlyCollection<T>

IEnumerable<T>

IEnumerable