Aspose::Slides::ICommentCollection Class Referenceabstract

Represents a collection of comments of one author. More...

Inherits Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::IComment > >.

Inherited by Aspose::Slides::CommentCollection.

Public Member Functions

virtual System::SharedPtr< ICommentidx_get (int32_t index)=0
 Gets the element at the specified index. Read-only IComment. More...
 
virtual System::SharedPtr< ICommentAddComment (System::String text, System::SharedPtr< ISlide > slide, System::Drawing::PointF position, System::DateTime creationTime)=0
 Add new comment at the end of a collection. More...
 
virtual System::SharedPtr< IModernCommentAddModernComment (System::String text, System::SharedPtr< ISlide > slide, System::SharedPtr< IShape > shape, System::Drawing::PointF position, System::DateTime creationTime)=0
 Add new modern comment at the end of a collection. More...
 
virtual System::SharedPtr< ICommentInsertComment (int32_t index, System::String text, System::SharedPtr< ISlide > slide, System::Drawing::PointF position, System::DateTime creationTime)=0
 Insert new comment to a collection at the specified index. More...
 
virtual System::SharedPtr< IModernCommentInsertModernComment (int32_t index, System::String text, System::SharedPtr< ISlide > slide, System::SharedPtr< IShape > shape, System::Drawing::PointF position, System::DateTime creationTime)=0
 Insert new modern comment to a collection at the specified index. More...
 
virtual System::ArrayPtr< System::SharedPtr< IComment > > ToArray ()=0
 Creates and returns an array with all comments. More...
 
virtual System::ArrayPtr< System::SharedPtr< IComment > > ToArray (int32_t startIndex, int32_t count)=0
 Creates and returns an array with all comments from the specified range. More...
 
virtual void RemoveAt (int32_t index)=0
 Removes the element at the specified index in a collection. More...
 
virtual void Remove (System::SharedPtr< IComment > comment)=0
 Removes the first occurrence of the specified comment in a collection. More...
 
virtual void Clear ()=0
 Removes all comments from a collection. More...
 
- Public Member Functions inherited from Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::IComment > >
virtual int32_t get_Count ()=0
 Returns the number of behaviors in a collection. Read-only int32_t. More...
 
virtual System::SharedPtr< System::Objectget_SyncRoot ()=0
 Returns a synchronization root. Read-only System::Object. More...
 
virtual bool get_IsSynchronized ()=0
 Returns a value indicating whether access to the collection is synchronized (thread-safe). Read-only bool. More...
 
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Slides::IComment > > array, int32_t index)=0
 Copies all elements from the collection into the specified array. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< T >
virtual SharedPtr< IEnumerator< T > > GetEnumerator ()=0
 Gets enumerator. More...
 
LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
LINQ_First ()
 Returns the first element of a sequence. More...
 
LINQ_First (const Func< T, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
LINQ_Last ()
 Returns the last element of a sequence. More...
 
LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< T > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< T, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< T > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(T)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(T)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (T value)
 Determines if a sequence contains a specified value. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderBy (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderByDescending (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 Transforms elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< T > > LINQ_Concat (SharedPtr< IEnumerable< T >> sequence)
 Concatenates two sequences. More...
 
template<typename Key >
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, T > > > > LINQ_GroupBy (System::Func< T, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< T, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 Gets the implementation of begin iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 Gets the implementation of end iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 Gets the implementation of begin const iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 Gets the implementation of end const iterator for the current container. More...
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::IEnumerable< T >
typedef IEnumerator< T > IEnumeratorType
 Enumerator type. More...
 
using ValueType = T
 
using iterator = System::Details::VirtualizedIterator< T >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< T >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< T >
 Inner iterator base type. More...
 
using virtualized_iterator_element = T
 Inner iterator element type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator ()
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator () const
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 

Detailed Description

Represents a collection of comments of one author.

Member Function Documentation

◆ AddComment()

virtual System::SharedPtr<IComment> Aspose::Slides::ICommentCollection::AddComment ( System::String  text,
System::SharedPtr< ISlide slide,
System::Drawing::PointF  position,
System::DateTime  creationTime 
)
pure virtual

Add new comment at the end of a collection.

Parameters
textPlain text of a new comment.
slideSlide in a presentation where to add a new comment.
positionPosition on a slide where to add a new comment.
creationTimeTime of a comment creation.
Returns
Added comment.

Implemented in Aspose::Slides::CommentCollection.

◆ AddModernComment()

virtual System::SharedPtr<IModernComment> Aspose::Slides::ICommentCollection::AddModernComment ( System::String  text,
System::SharedPtr< ISlide slide,
System::SharedPtr< IShape shape,
System::Drawing::PointF  position,
System::DateTime  creationTime 
)
pure virtual

Add new modern comment at the end of a collection.

Parameters
textPlain text of a new modern comment.
slideSlide in a presentation where to add a new modern comment.
shapeShape on a slide to which a new modern comment is associated.
positionPosition on a slide where to add a new modern comment.
creationTimeTime of a modern comment creation.
Returns
Added modern comment.
auto pres = System::MakeObject<Presentation>();
auto slide = pres->get_Slides()->idx_get(0);
auto newAuthor = pres->get_CommentAuthors()->AddAuthor(u"Some Author", u"SA");
newAuthor->get_Comments()->AddModernComment(u"This is modern comment", slide, nullptr, PointF(100.0f, 100.0f), DateTime::get_Now());
pres->Save(u"output.pptx", SaveFormat::Pptx);


Implemented in Aspose::Slides::CommentCollection.

◆ Clear()

virtual void Aspose::Slides::ICommentCollection::Clear ( )
pure virtual

Removes all comments from a collection.

Implemented in Aspose::Slides::CommentCollection.

◆ idx_get()

virtual System::SharedPtr<IComment> Aspose::Slides::ICommentCollection::idx_get ( int32_t  index)
pure virtual

Gets the element at the specified index. Read-only IComment.

Implemented in Aspose::Slides::CommentCollection.

◆ InsertComment()

virtual System::SharedPtr<IComment> Aspose::Slides::ICommentCollection::InsertComment ( int32_t  index,
System::String  text,
System::SharedPtr< ISlide slide,
System::Drawing::PointF  position,
System::DateTime  creationTime 
)
pure virtual

Insert new comment to a collection at the specified index.

Parameters
indexIndex of the element in a collection at which comment should be inserted.
textPlain text of a new comment.
slideSlide in a presentation where to add a new comment.
positionPosition on a slide where to add a new comment.
creationTimeTime of a comment creation.
Returns
Inserted comment.

Implemented in Aspose::Slides::CommentCollection.

◆ InsertModernComment()

virtual System::SharedPtr<IModernComment> Aspose::Slides::ICommentCollection::InsertModernComment ( int32_t  index,
System::String  text,
System::SharedPtr< ISlide slide,
System::SharedPtr< IShape shape,
System::Drawing::PointF  position,
System::DateTime  creationTime 
)
pure virtual

Insert new modern comment to a collection at the specified index.

Parameters
indexIndex of the element in a collection at which modern comment should be inserted.
textPlain text of a new modern comment.
slideSlide in a presentation where to add a new modern comment.
shapeShape on a slide to which a new modern comment is associated.
positionPosition on a slide where to add a new modern comment.
creationTimeTime of a modern comment creation.
Returns
Inserted modern comment.

Implemented in Aspose::Slides::CommentCollection.

◆ Remove()

virtual void Aspose::Slides::ICommentCollection::Remove ( System::SharedPtr< IComment comment)
pure virtual

Removes the first occurrence of the specified comment in a collection.

Parameters
commentThe comment to remove from a collection.
Exceptions
System::ArgumentNullExceptionIf comment is null
Aspose::Slides::PptxEditExceptionThrown if comment is already removed.

Implemented in Aspose::Slides::CommentCollection.

◆ RemoveAt()

virtual void Aspose::Slides::ICommentCollection::RemoveAt ( int32_t  index)
pure virtual

Removes the element at the specified index in a collection.

Parameters
indexThe zero-based index of the element to remove.
Exceptions
System::ArgumentOutOfRangeExceptionIndex is less than 0 or index is equal or greater than Count
Aspose::Slides::PptxEditExceptionThrown if comment is already removed.

Implemented in Aspose::Slides::CommentCollection.

◆ ToArray() [1/2]

virtual System::ArrayPtr<System::SharedPtr<IComment> > Aspose::Slides::ICommentCollection::ToArray ( )
pure virtual

Creates and returns an array with all comments.

Returns
Array of IComment.

Implemented in Aspose::Slides::CommentCollection.

◆ ToArray() [2/2]

virtual System::ArrayPtr<System::SharedPtr<IComment> > Aspose::Slides::ICommentCollection::ToArray ( int32_t  startIndex,
int32_t  count 
)
pure virtual

Creates and returns an array with all comments from the specified range.

Parameters
startIndexAn index of a first comment to return.
countA number of comments to return.
Returns
Array of IComment.

Implemented in Aspose::Slides::CommentCollection.