ExcelCommentCollection Class

Namespace:
GemBox.Spreadsheet
Assembly:
GemBox.Spreadsheet.dll

Collection of comments (ExcelComment).

public sealed class ExcelCommentCollection : IEnumerable<ExcelComment>, IEnumerable
Public NotInheritable Class ExcelCommentCollection
    Implements IEnumerable(Of ExcelComment), IEnumerable
Inheritance:
System.Object
ExcelCommentCollection
Implements
System.Collections.Generic.IEnumerable<ExcelComment>
System.Collections.IEnumerable

Properties

Count

Gets the number of comments contained in the collection.

public int Count { get; }
Public ReadOnly Property Count As Integer
Property Value
System.Int32

Item[Int32]

Gets the comment at the specified index.

public ExcelComment this[int index] { get; }
Public ReadOnly Property Item(index As Integer) As ExcelComment
Parameters
index
System.Int32

The zero-based index of the comment.

Property Value
ExcelComment

The comment at the specified index.

Exceptions
System.ArgumentOutOfRangeException

Argument index is out of range.

Methods

Clear()

Removes all comments.

public void Clear()
Public Sub Clear

GetEnumerator()

Returns an enumerator for the collection.

public IEnumerator<ExcelComment> GetEnumerator()
Public Function GetEnumerator As IEnumerator(Of ExcelComment)
Returns
System.Collections.Generic.IEnumerator<ExcelComment>

An enumerator for the collection.

Remove(ExcelComment)

Removes the first occurrence of a specific ExcelComment from the collection.

public bool Remove(ExcelComment item)
Public Function Remove(item As ExcelComment) As Boolean
Parameters
item
ExcelComment

The ExcelComment to remove from the collection.

Returns
System.Boolean

true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the original collection.

RemoveAt(Int32)

Removes the comment at the specified index.

public void RemoveAt(int index)
Public Sub RemoveAt(index As Integer)
Parameters
index
System.Int32

The zero-based index of the comment to remove.

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable