CommentCollection

CommentCollection

Overview

CommentCollection is a class in Aspose.Slides FOSS for Python. Inherits from: BaseCollection, ICommentCollection.

Represents a collection of comments of one author.

This class declares 13 methods for CommentCollection objects in Python programs. Available methods include: __contains__, __getitem__, __iter__, __len__, add_comment, clear, find_comment_by_idx, insert_comment, remove, remove_at, to_array. Public members are accessible to any Python application after installing the Aspose.Slides FOSS for Python package. Properties: as_i_collection, as_i_enumerable, length.

Properties

NameTypeAccessDescription
as_i_collectionlistReadGets the as i collection.
as_i_enumerableAnyReadGets the as i enumerable.
lengthintReadReturns the number of elements.

Methods

SignatureDescription
to_array() → list['IComment']Returns a list of IComment objects representing each comment in the collection
add_comment(text, slide, position, creation_time) → 'IComment'Add a comment to the end of this author’s comment collection for the given slide.
insert_comment(index, text, slide, position, creation_time) → 'IComment'Insert a comment at the given position in this author’s comment list.
remove_at(index: int)Removes the comment located at the given index from the collection
remove(comment)Remove the given comment (and its replies) from the collection.
clear()Remove all comments by this author across all slides.
find_comment_by_idx(idx) → Optional['IComment']Find a comment by its idx value (unique per author).
__getitem__(index: int) → 'Comment'Calls getitem(index) on this CommentCollection instance.
__len__() → intCalls len on this CommentCollection instance.
__iter__()Calls iter on this CommentCollection instance.
__contains__(item) → boolCalls contains(item) on this CommentCollection instance.
to_array(start_index, count) → list[IComment]Calls to_array(start_index, count) on this CommentCollection instance.
remove_at(index)Calls remove_at(index) on this CommentCollection instance.

See Also

 English