Class ExcelThreadedComment

Represents a comment in a thread of ThreadedComments

Inheritance
System.Object
XmlHelper
ExcelThreadedComment
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)
System.Object.ToString()
Namespace: OfficeOpenXml.ThreadedComments
Assembly: EPPlus.dll
Syntax
public class ExcelThreadedComment : XmlHelper

Properties

Author

Author of the comment

Declaration
public ExcelThreadedCommentPerson Author { get; }
Property Value
Type Description
ExcelThreadedCommentPerson

CellAddress

The location of the threaded comment

Declaration
public ExcelCellAddress CellAddress { get; }
Property Value
Type Description
ExcelCellAddress

ContainsMentions

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

Declaration
public bool ContainsMentions { get; }
Property Value
Type Description
System.Boolean

DateCreated

Timestamp for when the comment was created

Declaration
public DateTime DateCreated { get; set; }
Property Value
Type Description
System.DateTime

Id

Unique id

Declaration
public string Id { get; }
Property Value
Type Description
System.String

Mentions

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

Declaration
public ExcelThreadedCommentMentionCollection Mentions { get; }
Property Value
Type Description
ExcelThreadedCommentMentionCollection

ParentId

Id of the first comment in the thread

Declaration
public string ParentId { get; set; }
Property Value
Type Description
System.String

PersonId

Id of the ExcelThreadedCommentPerson who wrote the comment

Declaration
public string PersonId { get; set; }
Property Value
Type Description
System.String

Text

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

Declaration
public string Text { get; }
Property Value
Type Description
System.String

Methods

EditText(String)

Edit the Text of an existing comment

Declaration
public void EditText(string newText)
Parameters
Type Name Description
System.String newText

EditText(String, ExcelThreadedCommentPerson[])

Edit the Text of an existing comment with mentions

Declaration
public void EditText(string newTextWithFormats, params ExcelThreadedCommentPerson[] personsToMention)
Parameters
Type Name Description
System.String newTextWithFormats

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

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