Aspose::Slides::CommentCollection Class Referencefinal

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

Inherits Aspose::Slides::ICommentCollection, and Aspose::Slides::IDOMObject.

Public Member Functions

int32_t get_Count ()
 Gets the number of elements actually contained in the collection. Read-only int32_t. More...
 
bool get_IsSynchronized ()
 Returns a value indicating whether access to the collection is synchronized (thread-safe). Read-only bool. More...
 
System::SharedPtr< System::Objectget_SyncRoot ()
 Returns a synchronization root. Read-only object. More...
 
System::SharedPtr< IDOMObjectget_Parent_Immediate ()
 Returns Parent_Immediate object. Read-only IDOMObject. More...
 
System::SharedPtr< ICommentidx_get (int32_t index)
 Gets the element at the specified index. Read-only Comment. More...
 
System::SharedPtr< ICommentAddComment (System::String text, System::SharedPtr< ISlide > slide, System::Drawing::PointF position, System::DateTime creationTime)
 Add new comment at the end of a collection. More...
 
System::SharedPtr< ICommentInsertComment (int32_t index, System::String text, System::SharedPtr< ISlide > slide, System::Drawing::PointF position, System::DateTime creationTime)
 Insert new comment to a collection at the specified index. More...
 
System::ArrayPtr< System::SharedPtr< IComment > > ToArray ()
 Creates and returns an array with all comments. More...
 
System::ArrayPtr< System::SharedPtr< IComment > > ToArray (int32_t startIndex, int32_t count)
 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.
More...
 
void RemoveAt (int32_t index)
 Removes the element at the specified index in a collection. More...
 
void Remove (System::SharedPtr< IComment > comment)
 Removes the first occurrence of the specified comment in a collection. More...
 
void Clear ()
 Removes all comments from a collection. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< IComment > > > GetEnumerator ()
 Returns an enumerator that iterates through the collection. More...
 
System::SharedPtr< ICommentFindCommentByIdx (int32_t idx)
 Finds a comment in the collection by index. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< IComment >> array, int32_t index)
 
- Public Member Functions inherited from Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::IComment > >
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::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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

System::SharedPtr< Aspose::Slides::Presentationget_Presentation ()
 Returns parent Presentation object for a collection of comments. Read-only IPresentation. More...
 
 CommentCollection (System::SharedPtr< CommentAuthor > parentImmediate)
 
void RemoveInternal (System::SharedPtr< Comment > comment)
 
void SortByCreatedTime ()
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Slides::IComment > >
typedef IEnumerator< System::SharedPtr< Aspose::Slides::IComment > > IEnumeratorType
 Enumerator type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

Represents a collection of comments of one author.

Constructor & Destructor Documentation

◆ CommentCollection()

Aspose::Slides::CommentCollection::CommentCollection ( System::SharedPtr< CommentAuthor parentImmediate)
protected

Member Function Documentation

◆ AddComment()

System::SharedPtr<IComment> Aspose::Slides::CommentCollection::AddComment ( System::String  text,
System::SharedPtr< ISlide slide,
System::Drawing::PointF  position,
System::DateTime  creationTime 
)
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.

Implements Aspose::Slides::ICommentCollection.

◆ Clear()

void Aspose::Slides::CommentCollection::Clear ( )
virtual

Removes all comments from a collection.

Implements Aspose::Slides::ICommentCollection.

◆ CopyTo()

void Aspose::Slides::CommentCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< IComment >>  array,
int32_t  index 
)

◆ FindCommentByIdx()

System::SharedPtr<IComment> Aspose::Slides::CommentCollection::FindCommentByIdx ( int32_t  idx)

Finds a comment in the collection by index.

Parameters
idxUnique index of a comment to find int32_t.
Returns
Found comment or null IComment.

◆ get_Count()

int32_t Aspose::Slides::CommentCollection::get_Count ( )
virtual

Gets the number of elements actually contained in the collection. Read-only int32_t.

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

◆ get_IsSynchronized()

bool Aspose::Slides::CommentCollection::get_IsSynchronized ( )
virtual

Returns a value indicating whether access to the collection is synchronized (thread-safe). Read-only bool.

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

◆ get_Parent_Immediate()

System::SharedPtr<IDOMObject> Aspose::Slides::CommentCollection::get_Parent_Immediate ( )
virtual

Returns Parent_Immediate object. Read-only IDOMObject.

Implements Aspose::Slides::IDOMObject.

◆ get_Presentation()

System::SharedPtr<Aspose::Slides::Presentation> Aspose::Slides::CommentCollection::get_Presentation ( )
protected

Returns parent Presentation object for a collection of comments. Read-only IPresentation.

◆ get_SyncRoot()

System::SharedPtr<System::Object> Aspose::Slides::CommentCollection::get_SyncRoot ( )
virtual

Returns a synchronization root. Read-only object.

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

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<IComment> > > Aspose::Slides::CommentCollection::GetEnumerator ( )
virtual

Returns an enumerator that iterates through the collection.

Returns
A T:System::Collections::Generic::IEnumerator`1 that can be used to iterate through the collection.

Implements System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Slides::IComment > >.

◆ idx_get()

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

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

Implements Aspose::Slides::ICommentCollection.

◆ InsertComment()

System::SharedPtr<IComment> Aspose::Slides::CommentCollection::InsertComment ( int32_t  index,
System::String  text,
System::SharedPtr< ISlide slide,
System::Drawing::PointF  position,
System::DateTime  creationTime 
)
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.

Implements Aspose::Slides::ICommentCollection.

◆ Remove()

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

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

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

Implements Aspose::Slides::ICommentCollection.

◆ RemoveAt()

void Aspose::Slides::CommentCollection::RemoveAt ( int32_t  index)
virtual

Removes the element at the specified index in a collection.

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

Implements Aspose::Slides::ICommentCollection.

◆ RemoveInternal()

void Aspose::Slides::CommentCollection::RemoveInternal ( System::SharedPtr< Comment comment)
protected

◆ SortByCreatedTime()

void Aspose::Slides::CommentCollection::SortByCreatedTime ( )
protected

◆ ToArray() [1/2]

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

Creates and returns an array with all comments.

Returns
Array of Comment.

Implements Aspose::Slides::ICommentCollection.

◆ ToArray() [2/2]

System::ArrayPtr<System::SharedPtr<IComment> > Aspose::Slides::CommentCollection::ToArray ( int32_t  startIndex,
int32_t  count 
)
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 Comment.

Implements Aspose::Slides::ICommentCollection.