Class ExcelCommentCollection
Collection of Excel Comment objects
Inheritance
System.Object
ExcelCommentCollection
Implements
System.Collections.IEnumerable
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: OfficeOpenXml
Assembly: EPPlus.dll
Syntax
public class ExcelCommentCollection : IEnumerable, IDisposableProperties
CommentXml
Access to the comment xml document
Declaration
public XmlDocument CommentXml { get; set; }Property Value
| Type | Description |
|---|---|
| System.Xml.XmlDocument |
Count
Number of comments in the collection
Declaration
public int Count { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Item[ExcelCellAddress]
Indexer for the comments collection
Declaration
public ExcelComment this[ExcelCellAddress cell] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| ExcelCellAddress | cell | The cell |
Property Value
| Type | Description |
|---|---|
| ExcelComment | The comment |
Item[Int32]
Indexer for the comments collection
Declaration
public ExcelComment this[int Index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | Index | The index |
Property Value
| Type | Description |
|---|---|
| ExcelComment | The comment |
Item[String]
Indexer for the comments collection
Declaration
public ExcelComment this[string cellAddress] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.String | cellAddress | The cell address |
Property Value
| Type | Description |
|---|---|
| ExcelComment | The comment |
Worksheet
A reference to the worksheet object
Declaration
public ExcelWorksheet Worksheet { get; set; }Property Value
| Type | Description |
|---|---|
| ExcelWorksheet |
Methods
Add(ExcelRangeBase, String, String)
Adds a comment to the top left cell of the range
Declaration
public ExcelComment Add(ExcelRangeBase cell, string Text, string author = null)Parameters
| Type | Name | Description |
|---|---|---|
| ExcelRangeBase | cell | The cell |
| System.String | Text | The comment text |
| System.String | author | The author for the comment. If this property is null or blank EPPlus will set it to the identity of the ClaimsPrincipal if available otherwise to "Anonymous" |
Returns
| Type | Description |
|---|---|
| ExcelComment | The comment |
Remove(ExcelComment)
Removes the comment
Declaration
public void Remove(ExcelComment comment)Parameters
| Type | Name | Description |
|---|---|---|
| ExcelComment | comment | The comment to remove |
RemoveAt(Int32)
Removes the comment at the specified position
Declaration
public void RemoveAt(int Index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | Index | The index |
Explicit Interface Implementations
IEnumerable.GetEnumerator()
Declaration
IEnumerator IEnumerable.GetEnumerator()Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerator |
IDisposable.Dispose()
Declaration
void IDisposable.Dispose()Implements
System.Collections.IEnumerable
System.IDisposable