CommentCollection

CommentCollection

Overview

CommentCollection is a class in Aspose.Slides FOSS for C++.

Manages a collection of comments belonging to a single author.

This class declares 16 methods for CommentCollection objects in C++ programs. Available methods include: CommentCollection, ICommentCollection, add_comment, as_i_collection, as_i_enumerable, clear, find_comment_by_idx, insert_comment, remove, remove_at, remove_comment, size, and 1 additional methods. Public members are accessible to any C++ application after installing the Aspose.Slides FOSS for C++ package. Accessor methods: CommentCollection, ICommentCollection.

Accessor Methods

NameTypeAccessDescription
CommentCollectionCommentCollectionReadGets the comment collection.
ICommentCollectionICommentCollectionReadGets the i comment collection.

Methods

SignatureDescription
CommentCollection() → CommentCollectionProperty provides access to the underlying comment collection instance
ICommentCollection() → ICommentCollectionReturns a reference to this collection as a generic collection interface.
ICommentCollection() → ICommentCollectionReturns a reference to this collection as a generic enumerable interface.
CommentCollection()
add_comment(text: std::string, slide: Slide, position: Drawing::PointF, created_time: std::chrono::system_clock::time_point) → CommentAdds a new comment and returns a reference to it. position is in centimetres from the top-left corner of the slide.
insert_comment(index: std::size_t, text: std::string, slide: Slide, position: Drawing::PointF, created_time: std::chrono::system_clock::time_point) → CommentInserts a comment at the given index and returns a reference to it. position is in centimetres from the top-left corner of the slide.
remove_at(index: std::size_t)Removes the comment at the given index.
remove(comment: Comment)Removes the given comment (and its replies) from the collection.
clear()Removes all comments from this collection.
size() → std::size_tReturns the number of comments.
to_array() → std::vector<Comment*>Returns a vector of non-owning pointers to all comments.
to_array(start: std::size_t, count: std::size_t) → std::vector<Comment*>Returns a vector of comments in the specified range.
find_comment_by_idx(idx: std::uint32_t) → CommentFinds a comment by its unique per-author index, or nullptr if not found.
as_i_collection() → ICommentCollectionReturns a reference to this collection as a generic collection interface.
as_i_enumerable() → ICommentCollectionReturns a reference to this collection as a generic enumerable interface.
remove_comment(comment: Comment)Removes a specific comment by pointer (used internally by Comment::remove).

See Also

 English