Class ExcelThreadedComment

Namespace

OfficeOpenXml.ThreadedComments

Assembly

EPPlus.dll

Represents a comment in a thread of ThreadedComments

public class ExcelThreadedComment : XmlHelper

Inheritance

object

XmlHelper

ExcelThreadedComment

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Author

Author of the comment

public ExcelThreadedCommentPerson Author { get; }

Property Value

ExcelThreadedCommentPerson

CellAddress

The location of the threaded comment

public ExcelCellAddress CellAddress { get; }

Property Value

ExcelCellAddress

ContainsMentions

Indicates whether the Text contains mentions. If so the Mentions property will contain data about those mentions.

public bool ContainsMentions { get; }

Property Value

bool

DateCreated

Timestamp for when the comment was created

public DateTime DateCreated { get; set; }

Property Value

DateTime

Id

Unique id

public string Id { get; }

Property Value

string

Mentions

Mentions in this comment. Will return null if no mentions exists.

public ExcelThreadedCommentMentionCollection Mentions { get; }

Property Value

ExcelThreadedCommentMentionCollection

ParentId

Id of the first comment in the thread

public string ParentId { get; set; }

Property Value

string

PersonId

Id of the ExcelThreadedCommentPerson who wrote the comment

public string PersonId { get; set; }

Property Value

string

Text

Text of the comment. To edit the text on an existing comment, use the EditText function.

public string Text { get; }

Property Value

string

Methods

EditText(string)

Edit the Text of an existing comment

public void EditText(string newText)

Parameters

newText string

EditText(string, params ExcelThreadedCommentPerson[])

Edit the Text of an existing comment with mentions

public void EditText(string newTextWithFormats, params ExcelThreadedCommentPerson[] personsToMention)

Parameters

newTextWithFormats string

A string with format placeholders - same as in string.Format. Index in these should correspond to an index in the personsToMention array.

personsToMention ExcelThreadedCommentPerson[]

A params array of ExcelThreadedCommentPerson. Their DisplayName property will be used to replace the format placeholders.