Click or drag to resize

Comment Class

Represents a container for text of a comment.
Inheritance Hierarchy

Namespace: Spire.Doc.Fields
Assembly: Spire.Doc (in Spire.Doc.dll) Version: 13.2.3.0 (13.2.3.3046)
Syntax
Copy 
public class Comment : ParagraphBase, ICompositeObject, 
	IDocumentObject

The Comment type exposes the following members.

Constructors
Name Description
Public method Comment
Initializes a new instance of the [!:WComment] class.
Top
Properties
Name Description
Public property Body
Gets comment body.
Public property ByRepliedComment
Gets the comment of current comment replied.
Public property CharacterFormat
Gets the character format.
(Inherited from ParagraphBase .)
Public property ChildObjects
Gets the child document objects.
(Overrides ParagraphBase ChildObjects .)
Public property CommentMarkEnd
Gets the ending mark of the comment.
Public property CommentMarkStart
Gets the begining mark of the comment.
Public property DeleteRevision
Gets the delete revision for this objects. Note this can be null. If null does not have delete revision.
(Inherited from ParagraphBase .)
Public property Document
Gets the document.
(Inherited from OwnerHolder .)
Public property DocumentObjectType
Gets the type of the document object.
(Overrides DocumentObject DocumentObjectType .)
Public property FirstChild
Gets the first child of the Element.
(Inherited from DocumentObject .)
Public property Format
Gets the format.
Public property InsertRevision
Gets the insert revision for this objects. Note this can be null. If null does not have insert revision.
(Inherited from ParagraphBase .)
Public property IsComposite
Indicating whether this instance is composite.
(Inherited from DocumentObject .)
Public property IsDeleteRevision
Gets or set a value indicating whether this item was deleted from the document, when "Track Changes" is or was set to "true".
(Inherited from ParagraphBase .)
Public property IsInsertRevision
Gets a value indicating whether this item was inserted to the document, when "Track Changes" is or was set to "true".
(Inherited from ParagraphBase .)
Public property Items
Gets the range of commented items.
Public property LastChild
Gets the last child of the Element.
(Inherited from DocumentObject .)
Public property MarkDone
Gets a value indicating whether done.
Public property NextSibling
Gets the next sibling.
(Inherited from DocumentObject .)
Public property Owner
Gets the owner of this entity.
(Inherited from DocumentObject .)
Public property OwnerParagraph
Gets owner paragraph.
(Inherited from ParagraphBase .)
Public property PreviousSibling
Gets the previous sibling.
(Inherited from DocumentObject .)
Public property ReplyCommentItems
Gets the range of commented items.
Public property StyleName
Gets the style name.
(Inherited from ParagraphBase .)
Protected property XDLSHolder (Inherited from DocumentSerializable .)
Top
Methods
Name Description
Public method AddItem
Adds the paragraph item to the commented items.
Public method ApplyCharacterFormat
Applies the specified character format to the current object.
(Inherited from ParagraphBase .)
Public method ApplyStyle
Applies the specified character style to the current object. If the specified style does not exist and the style name is "default paragraph font", a new built-in style is created and added to the document. If the specified style still cannot be found, an ArgumentException is thrown.
(Inherited from ParagraphBase .)
Public method Clear
Clears the commented items.
Public method Clone
Creates a duplicate of the document object.
(Inherited from DocumentObject .)
Protected method CloneImpl (Overrides ParagraphBase CloneImpl .)
Protected method CreateLayoutInfo (Overrides DocumentBase CreateLayoutInfo .)
Public method EnsureMinimum
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetNextWidgetSibling
Gets the next widget sibling.
(Inherited from ParagraphBase .)
Public method GetPreviousWidgetSibling
Gets the previous widget sibling.
(Inherited from ParagraphBase .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Protected method InitXDLSHolder (Overrides DocumentSerializable InitXDLSHolder .)
Public method MarkCommentDone
Marks the comment done.
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method ReadXmlAttributes (Inherited from DocumentSerializable .)
Protected method ReadXmlContent (Inherited from DocumentSerializable .)
Public method Replace(String)
Replace commented items with matchString text.
Public method Replace(TextBodyPart)
Replaces the commented items with specified TextBodyPart.
Public method ReplyToComment
Replies to comment.
Protected method RestoreReference (Inherited from DocumentSerializable .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Public method ToString(String)
Exports the name and index in container of the object into a string in the specified seperator.
(Inherited from DocumentObject .)
Protected method WriteXmlAttributes (Overrides DocumentSerializable WriteXmlAttributes(IXDLSAttributeWriter) .)
Protected method WriteXmlContent (Inherited from DocumentSerializable .)
Top
Fields
Name Description
Protected field m_doc (Inherited from OwnerHolder .)
Protected field m_format
Protected field m_textBody
Top
See Also