Class ExcelWorksheetThreadedComments¶

Namespace: OfficeOpenXml.ThreadedComments
Assembly: EPPlus.dll

Accessor for ExcelThreadedComments on a ExcelWorksheet

public class ExcelWorksheetThreadedComments : IEnumerable<ExcelThreadedCommentThread>, IEnumerable

Inheritance¶

object ← ExcelWorksheetThreadedComments

Implements¶

IEnumerable
IEnumerable<ExcelThreadedCommentThread>

Inherited Members¶

object.Equals(object?, object?)
object.Equals(object?)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object?, object?)
object.ToString()

Properties¶

Count¶

Number of ExcelThreadedCommentThreads on the ExcelWorksheet?text=worksheet

public int Count { get; }

Property Value¶

int

Persons¶

A collection of persons referenced by the threaded comments.

public ExcelThreadedCommentPersonCollection Persons { get; }

Property Value¶

ExcelThreadedCommentPersonCollection

ThreadedCommentsXml¶

The raw xml for the threaded comments

public XmlDocument ThreadedCommentsXml { get; }

Property Value¶

XmlDocument

Threads¶

An enumerable of the existing ExcelThreadedCommentThreads on the ExcelWorksheet?text=worksheet

public IEnumerable<ExcelThreadedCommentThread> Threads { get; }

Property Value¶

IEnumerable<ExcelThreadedCommentThread>

this[string]¶

Returns a ExcelThreadedCommentThread for the requested cellAddress.

public ExcelThreadedCommentThread this[string cellAddress] { get; }

Property Value¶

ExcelThreadedCommentThread

this[ExcelCellAddress]¶

Returns a ExcelThreadedCommentThread for the requested cellAddress.

public ExcelThreadedCommentThread this[ExcelCellAddress cellAddress] { get; }

Property Value¶

ExcelThreadedCommentThread

this[int]¶

Returns a ExcelThreadedCommentThread for the requested index.

public ExcelThreadedCommentThread this[int index] { get; }

Property Value¶

ExcelThreadedCommentThread

Methods¶

Add(string)¶

Adds a new ExcelThreadedCommentThread to the cell.

public ExcelThreadedCommentThread Add(string cellAddress)

Parameters¶

cellAddress string

Returns¶

ExcelThreadedCommentThread

The new, empty ExcelThreadedCommentThread

Exceptions¶

ArgumentException

Thrown if there was an existing ExcelThreadedCommentThread in the cell.

Add(ExcelCellAddress)¶

Adds a new ExcelThreadedCommentThread to the cell.

public ExcelThreadedCommentThread Add(ExcelCellAddress cellAddress)

Parameters¶

cellAddress ExcelCellAddress

The cell address

Returns¶

ExcelThreadedCommentThread

The new, empty ExcelThreadedCommentThread

Exceptions¶

ArgumentException

Thrown if there was an existing ExcelThreadedCommentThread in the cell.

InvalidOperationException

If a note/comment exist in the cell

GetEnumerator()¶

Returns the enumerator

public IEnumerator<ExcelThreadedCommentThread> GetEnumerator()

Returns¶

IEnumerator<ExcelThreadedCommentThread>

Returns an enumeration of ExcelThreadedCommentThread

Remove(ExcelThreadedCommentThread)¶

Removes the ExcelThreadedCommentThread supplied

public void Remove(ExcelThreadedCommentThread threadedComment)

Parameters¶

threadedComment ExcelThreadedCommentThread

An existing ExcelThreadedCommentThread in the worksheet

RemoveAt(int)¶

Removes the ExcelThreadedCommentThread index position in the collection

public void RemoveAt(int index)

Parameters¶

index int

The index for the threaded comment to be removed

ToString()¶

Returns a string that represents the current object.

public override string ToString()

Returns¶

string

A string that represents the current object.