Class ExcelWorksheetThreadedComments

Namespace

OfficeOpenXml.ThreadedComments

Assembly

EPPlus.dll

Accessor for ExcelThreadedComments on a ExcelWorksheet

public class ExcelWorksheetThreadedComments

Inheritance

object

ExcelWorksheetThreadedComments

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Count

Number of ExcelThreadedCommentThreads on the worksheet

public int Count { get; }

Property Value

int

this[ExcelCellAddress]

Returns a ExcelThreadedCommentThread for the requested cellAddress.

public ExcelThreadedCommentThread this[ExcelCellAddress cellAddress] { get; }

Parameters

cellAddress ExcelCellAddress

The requested cell address in A1 format

Property Value

ExcelThreadedCommentThread

An existing ExcelThreadedCommentThread or null if no thread exists

this[int]

Returns a ExcelThreadedCommentThread for the requested index.

public ExcelThreadedCommentThread this[int index] { get; }

Parameters

index int

The index in the collection

Property Value

ExcelThreadedCommentThread

An existing ExcelThreadedCommentThread or null if no thread exists

this[string]

Returns a ExcelThreadedCommentThread for the requested cellAddress.

public ExcelThreadedCommentThread this[string cellAddress] { get; }

Parameters

cellAddress string

The requested cell address in A1 format

Property Value

ExcelThreadedCommentThread

An existing ExcelThreadedCommentThread or null if no thread exists

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 worksheet

public IEnumerable<ExcelThreadedCommentThread> Threads { get; }

Property Value

IEnumerable<ExcelThreadedCommentThread>

Methods

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

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.

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.