GrapeCity.Documents.Word.Comment

Class Comment

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents a comment range in a body content.

public class Comment : ContentRange, IBrowsable<Comment>

Inheritance

object

ContentRange

Comment

Implements

IBrowsable<Comment>

Inherited Members

ContentRange.GetRange()

ContentRange.Start

ContentRange.End

ContentRange.ParentBody

ContentRange.Document

ContentRange.Children

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Ancestor

Gets the parent Comment for comments that are replies to an existing comment.

For new (top-level) comments returns null.

public Comment Ancestor { get; }

Property Value

Comment

Author

Gets or sets the author of this comment.

public string Author { get; set; }

Property Value

string

Body

Gets the content of this comment.

public Body Body { get; }

Property Value

Body

Date

Gets or sets the date of this comment.

public DateTime Date { get; set; }

Property Value

System.DateTime

Done

Gets or sets a value indicating whether the comment has been marked closed.

public bool Done { get; set; }

Property Value

bool

EndDisplacedByCustomXml

Gets or sets a value indicating that the end annotation's placement shall be directly linked with the location of the physical presentation of a custom XML element in the document.

public DisplacedByCustomXml EndDisplacedByCustomXml { get; set; }

Property Value

DisplacedByCustomXml

ID

Gets the unique ID of this comment.

public long ID { get; }

Property Value

long

Initials

Gets or sets the initials of the author of this comment.

public string Initials { get; set; }

Property Value

string

Remarks

This information can be used to format and present the associated comment, or in any user interface supported by an application. If there is more than one author with the same initials, it might be more useful to display the author name.

Next

Gets the next comment.

public Comment Next { get; }

Property Value

Comment

Previous

Gets the previous comment.

public Comment Previous { get; }

Property Value

Comment

Reference

Gets the comment content reference mark that links to this comment content.

public CommentReference Reference { get; }

Property Value

CommentReference

Replies

Gets the list of child Comment objects that are replies to this comment.

public IReadOnlyList<Comment> Replies { get; }

Property Value

System.Collections.Generic.IReadOnlyList<T><Comment>

StartDisplacedByCustomXml

Gets or sets a value indicating that the start annotation's placement shall be directly linked with the location of the physical presentation of a custom XML element in the document.

public DisplacedByCustomXml StartDisplacedByCustomXml { get; set; }

Property Value

DisplacedByCustomXml

Methods

Delete()

Deletes this comment from the parent Body.

public override void Delete()

Delete(bool)

Deletes this comment and optionally all replies associated with it from the parent Body.

public void Delete(bool includeReplies)

Parameters

includeReplies bool

Indicates whether to delete all replies associated with this comment.

Reply(string, string, DateTime, string)

Adds a new Comment to the Replies collection of this comment.

public Comment Reply(string text, string author, DateTime date, string initials)

Parameters

text string

The new comment text.

author string

The new comment author.

date System.DateTime

The new comment date.

initials string

The new comment author initials.

Returns

Comment

The newly added reply.

Reply(string, string, DateTime)

Adds a new Comment to the Replies collection of this comment.

public Comment Reply(string text, string author, DateTime date)

Parameters

text string

The new comment text.

author string

The new comment author.

date System.DateTime

The new comment date.

Returns

Comment

The newly added reply.

Reply(string, string)

Adds a new Comment to the Replies collection of this comment.

public Comment Reply(string text, string author)

Parameters

text string

The new comment text.

author string

The new comment author.

Returns

Comment

The newly added reply.

ToString()

Gets string representation of the content.

public override string ToString()

Returns

string

String representation of the content.