Aspose::Slides::CommentAuthorCollection Class Referencefinal

Represents a collection of comment authors. More...

Inherits Aspose::Slides::ICommentAuthorCollection, 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< ICommentAuthoridx_get (int32_t index)
 Gets the element at the specified index. Read-only ICommentAuthor. More...
 
System::SharedPtr< ICommentAuthorAddAuthor (System::String name, System::String initials)
 Add new author at the end of a collection. More...
 
System::ArrayPtr< System::SharedPtr< ICommentAuthor > > ToArray ()
 Creates and returns an array with all authors. More...
 
System::ArrayPtr< System::SharedPtr< ICommentAuthor > > FindByName (System::String name)
 Find author in a collection by name. More...
 
System::ArrayPtr< System::SharedPtr< ICommentAuthor > > FindByNameAndInitials (System::String name, System::String initials)
 Find author in a collection by name and initials. More...
 
void RemoveAt (int32_t index)
 Removes the author at the specified index of the collection. More...
 
void Remove (System::SharedPtr< ICommentAuthor > author)
 Removes the first occurrence of the specified author in a collection. More...
 
void Clear ()
 Removes all authors from a collection. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< ICommentAuthor > > > GetEnumerator ()
 Returns an enumerator that iterates through the collection. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< ICommentAuthor >> array, int32_t index)
 
- Public Member Functions inherited from Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::ICommentAuthor > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Slides::ICommentAuthor > > 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 ()
 
 CommentAuthorCollection (System::SharedPtr< Aspose::Slides::Presentation > parentImmediate)
 
bool RemoveInternal (System::SharedPtr< ICommentAuthor > author)
 
System::SharedPtr< CommentAuthorFindByIndex (int32_t idx)
 Finds an author in the collection by its index. More...
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Slides::ICommentAuthor > >
typedef IEnumerator< System::SharedPtr< Aspose::Slides::ICommentAuthor > > 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 comment authors.

Constructor & Destructor Documentation

◆ CommentAuthorCollection()

Aspose::Slides::CommentAuthorCollection::CommentAuthorCollection ( System::SharedPtr< Aspose::Slides::Presentation parentImmediate)
protected

Member Function Documentation

◆ AddAuthor()

System::SharedPtr<ICommentAuthor> Aspose::Slides::CommentAuthorCollection::AddAuthor ( System::String  name,
System::String  initials 
)
virtual

Add new author at the end of a collection.

Parameters
nameName of a new author.
initialsInitials of a new author.
Returns

Implements Aspose::Slides::ICommentAuthorCollection.

◆ Clear()

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

Removes all authors from a collection.

Implements Aspose::Slides::ICommentAuthorCollection.

◆ CopyTo()

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

◆ FindByIndex()

System::SharedPtr<CommentAuthor> Aspose::Slides::CommentAuthorCollection::FindByIndex ( int32_t  idx)
protected

Finds an author in the collection by its index.

Parameters
idxUnique index of an author to find int32_t.
Returns
Finded author or null CommentAuthor.

◆ FindByName()

System::ArrayPtr<System::SharedPtr<ICommentAuthor> > Aspose::Slides::CommentAuthorCollection::FindByName ( System::String  name)
virtual

Find author in a collection by name.

Parameters
nameName of an author to find.
Returns
Author or null.

Implements Aspose::Slides::ICommentAuthorCollection.

◆ FindByNameAndInitials()

System::ArrayPtr<System::SharedPtr<ICommentAuthor> > Aspose::Slides::CommentAuthorCollection::FindByNameAndInitials ( System::String  name,
System::String  initials 
)
virtual

Find author in a collection by name and initials.

Parameters
nameName of an author to find.
initialsInitials of an author to find.
Returns
Author or null.

Implements Aspose::Slides::ICommentAuthorCollection.

◆ get_Count()

int32_t Aspose::Slides::CommentAuthorCollection::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::ICommentAuthor > >.

◆ get_IsSynchronized()

bool Aspose::Slides::CommentAuthorCollection::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::ICommentAuthor > >.

◆ get_Parent_Immediate()

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

Returns Parent_Immediate object. Read-only IDOMObject.

Implements Aspose::Slides::IDOMObject.

◆ get_Presentation()

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

◆ get_SyncRoot()

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

Returns a synchronization root. Read-only object.

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

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<ICommentAuthor> > > Aspose::Slides::CommentAuthorCollection::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::ICommentAuthor > >.

◆ idx_get()

System::SharedPtr<ICommentAuthor> Aspose::Slides::CommentAuthorCollection::idx_get ( int32_t  index)
virtual

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

Implements Aspose::Slides::ICommentAuthorCollection.

◆ Remove()

void Aspose::Slides::CommentAuthorCollection::Remove ( System::SharedPtr< ICommentAuthor author)
virtual

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

Parameters
authorThe author to remove from a collection.
Exceptions
ArgumentNullExceptionAuthor is null
PptxEditExceptionThrown if author is already removed.

Implements Aspose::Slides::ICommentAuthorCollection.

◆ RemoveAt()

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

Removes the author at the specified index of the 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 author is already removed.

Implements Aspose::Slides::ICommentAuthorCollection.

◆ RemoveInternal()

bool Aspose::Slides::CommentAuthorCollection::RemoveInternal ( System::SharedPtr< ICommentAuthor author)
protected

◆ ToArray()

System::ArrayPtr<System::SharedPtr<ICommentAuthor> > Aspose::Slides::CommentAuthorCollection::ToArray ( )
virtual

Creates and returns an array with all authors.

Returns
Array of ICommentAuthor

Implements Aspose::Slides::ICommentAuthorCollection.