Class ExcelWorksheetThreadedComments

Accessor for ExcelThreadedComments on a ExcelWorksheet

Inheritance

System.Object

ExcelWorksheetThreadedComments

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)

Namespace: OfficeOpenXml.ThreadedComments

Assembly: EPPlus.dll

Syntax

public class ExcelWorksheetThreadedComments

Properties

Count

Number of ExcelThreadedCommentThreads on the ExcelWorksheet

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

Item[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

Item[Int32]

Returns a ExcelThreadedCommentThread for the requested index.

Declaration

public ExcelThreadedCommentThread this[int index] { get; }

Parameters

Type	Name	Description
System.Int32	index	The index in the collection

Property Value

Type	Description
ExcelThreadedCommentThread	An existing ExcelThreadedCommentThread or null if no thread exists

Item[String]

Returns a ExcelThreadedCommentThread for the requested cellAddress.

Declaration

public ExcelThreadedCommentThread this[string cellAddress] { get; }

Parameters

Type	Name	Description
System.String	cellAddress	The requested cell address in A1 format

Property Value

Type	Description
ExcelThreadedCommentThread	An existing ExcelThreadedCommentThread or null if no thread exists

Persons

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
System.Xml.XmlDocument

Threads

An enumerable of the existing ExcelThreadedCommentThreads on the ExcelWorksheet

Declaration

public IEnumerable<ExcelThreadedCommentThread> Threads { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<ExcelThreadedCommentThread>

Methods

Add(ExcelCellAddress)

Declaration

public ExcelThreadedCommentThread Add(ExcelCellAddress cellAddress)

Parameters

Type	Name	Description
ExcelCellAddress	cellAddress

Returns

Type	Description
ExcelThreadedCommentThread

Add(String)

Adds a new ExcelThreadedCommentThread to the cell.

Declaration

public ExcelThreadedCommentThread Add(string cellAddress)

Parameters

Type	Name	Description
System.String	cellAddress

Returns

Type	Description
ExcelThreadedCommentThread	The new, empty ExcelThreadedCommentThread

Exceptions

Type	Condition
System.ArgumentException	Thrown if there was an existing ExcelThreadedCommentThread in the cell.

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(Int32)

Removes the ExcelThreadedCommentThread index position in the collection

Declaration

public void RemoveAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The index for the threaded comment to be removed

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()