Class ExcelWorksheetThreadedComments
Accessor for ExcelThreadedComments on a ExcelWorksheet
Inherited Members
Namespace: OfficeOpenXml.ThreadedComments
Assembly: EPPlus.dll
Syntax
public class ExcelWorksheetThreadedComments : IEnumerable<ExcelThreadedCommentThread>, IEnumerableProperties
Count
Number of ExcelThreadedCommentThreads on the worksheet
Declaration
public int Count { get; }Property Value
| Type | Description |
|---|---|
| int |
this[ExcelCellAddress]
Returns a ExcelThreadedCommentThread for the requested cellAddress.
Declaration
public ExcelThreadedCommentThread this[ExcelCellAddress cellAddress] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| ExcelCellAddress | cellAddress | The requested cell address in A1 format |
Property Value
| Type | Description |
|---|---|
| ExcelThreadedCommentThread | An existing ExcelThreadedCommentThread or null if no thread exists |
this[int]
Returns a ExcelThreadedCommentThread for the requested index.
Declaration
public ExcelThreadedCommentThread this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index in the collection |
Property Value
| Type | Description |
|---|---|
| ExcelThreadedCommentThread | An existing ExcelThreadedCommentThread or null if no thread exists |
this[string]
Returns a ExcelThreadedCommentThread for the requested cellAddress.
Declaration
public ExcelThreadedCommentThread this[string cellAddress] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| string | cellAddress | The requested cell address in A1 format |
Property Value
| Type | Description |
|---|---|
| ExcelThreadedCommentThread | An existing ExcelThreadedCommentThread or null if no thread exists |
Persons
A collection of persons referenced by the threaded comments.
Declaration
public ExcelThreadedCommentPersonCollection Persons { get; }Property Value
| Type | Description |
|---|---|
| ExcelThreadedCommentPersonCollection |
ThreadedCommentsXml
The raw xml for the threaded comments
Declaration
public XmlDocument ThreadedCommentsXml { get; }Property Value
| Type | Description |
|---|---|
| XmlDocument |
Threads
An enumerable of the existing ExcelThreadedCommentThreads on the worksheet
Declaration
public IEnumerable<ExcelThreadedCommentThread> Threads { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<ExcelThreadedCommentThread> |
Methods
Add(ExcelCellAddress)
Adds a new ExcelThreadedCommentThread to the cell.
Declaration
public ExcelThreadedCommentThread Add(ExcelCellAddress cellAddress)Parameters
| Type | Name | Description |
|---|---|---|
| ExcelCellAddress | cellAddress | The cell address |
Returns
| Type | Description |
|---|---|
| ExcelThreadedCommentThread | The new, empty ExcelThreadedCommentThread |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown if there was an existing ExcelThreadedCommentThread in the cell. |
| InvalidOperationException | If a note/comment exist in the cell |
Add(string)
Adds a new ExcelThreadedCommentThread to the cell.
Declaration
public ExcelThreadedCommentThread Add(string cellAddress)Parameters
| Type | Name | Description |
|---|---|---|
| string | cellAddress |
Returns
| Type | Description |
|---|---|
| ExcelThreadedCommentThread | The new, empty ExcelThreadedCommentThread |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown if there was an existing ExcelThreadedCommentThread in the cell. |
GetEnumerator()
Returns the enumerator
Declaration
public IEnumerator<ExcelThreadedCommentThread> GetEnumerator()Returns
| Type | Description |
|---|---|
| IEnumerator<ExcelThreadedCommentThread> | Returns an enumeration of ExcelThreadedCommentThread |
Remove(ExcelThreadedCommentThread)
Removes the ExcelThreadedCommentThread supplied
Declaration
public void Remove(ExcelThreadedCommentThread threadedComment)Parameters
| Type | Name | Description |
|---|---|---|
| ExcelThreadedCommentThread | threadedComment | An existing ExcelThreadedCommentThread in the worksheet |
RemoveAt(int)
Removes the ExcelThreadedCommentThread index position in the collection
Declaration
public void RemoveAt(int index)Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index for the threaded comment to be removed |
ToString()
Returns a string that represents the current object.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string | A string that represents the current object. |