Aspose::Slides::LayoutSlideCollection Class Reference

Represents a base class for collection of a layout slides. More...

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

Inherited by Aspose::Slides::GlobalLayoutSlideCollection, and Aspose::Slides::MasterLayoutSlideCollection.

Public Member Functions

int32_t get_Count ()
 Returns the number of layout slides in a 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< ILayoutSlideidx_get (int32_t index)
 Returns the layout slide by index. Read-only LayoutSlide. More...
 
System::SharedPtr< ILayoutSlideGetByType (SlideLayoutType type)
 Returns the first layout slide of specified type.

Parameters
typeA type of layout slide to find.
Returns
LayoutSlide with specified type or null if no layouts found.
More...
 
void Remove (System::SharedPtr< ILayoutSlide > value)
 Removes a layout from the collection. More...
 
void RemoveUnused ()
 Removes unused layout slides (layout slides whose HasDependingSlides is false). More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< ILayoutSlide > > > GetEnumerator ()
 Returns an enumerator that iterates through the collection. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< ILayoutSlide >> array, int32_t index)
 
- Public Member Functions inherited from Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::ILayoutSlide > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Slides::ILayoutSlide > > 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< Presentationget_PresentationInternal ()
 
System::SharedPtr< IPresentationComponentget_Parent_IPresentationComponent ()
 
 LayoutSlideCollection (System::SharedPtr< IDOMObject > parentImmediate)
 
System::SharedPtr< LayoutSlideGetById (uint32_t id)
 
int32_t IndexOf (System::SharedPtr< ILayoutSlide > value)
 
virtual void Add (System::SharedPtr< ILayoutSlide > value)
 
void Insert (int32_t index, System::SharedPtr< ILayoutSlide > value)
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Slides::ILayoutSlide > >
typedef IEnumerator< System::SharedPtr< Aspose::Slides::ILayoutSlide > > 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 base class for collection of a layout slides.

Constructor & Destructor Documentation

◆ LayoutSlideCollection()

Aspose::Slides::LayoutSlideCollection::LayoutSlideCollection ( System::SharedPtr< IDOMObject parentImmediate)
protected

Member Function Documentation

◆ Add()

virtual void Aspose::Slides::LayoutSlideCollection::Add ( System::SharedPtr< ILayoutSlide value)
protectedvirtual

◆ CopyTo()

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

◆ get_Count()

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

Returns the number of layout slides in a collection. Read-only int32_t.

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

◆ get_IsSynchronized()

bool Aspose::Slides::LayoutSlideCollection::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::ILayoutSlide > >.

◆ get_Parent_Immediate()

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

Returns Parent_Immediate object. Read-only IDOMObject.

Implements Aspose::Slides::IDOMObject.

◆ get_Parent_IPresentationComponent()

System::SharedPtr<IPresentationComponent> Aspose::Slides::LayoutSlideCollection::get_Parent_IPresentationComponent ( )
protected

◆ get_PresentationInternal()

System::SharedPtr<Presentation> Aspose::Slides::LayoutSlideCollection::get_PresentationInternal ( )
protected

◆ get_SyncRoot()

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

Returns a synchronization root. Read-only object.

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

◆ GetById()

System::SharedPtr<LayoutSlide> Aspose::Slides::LayoutSlideCollection::GetById ( uint32_t  id)
protected

◆ GetByType()

System::SharedPtr<ILayoutSlide> Aspose::Slides::LayoutSlideCollection::GetByType ( SlideLayoutType  type)
virtual

Returns the first layout slide of specified type.

Parameters
typeA type of layout slide to find.
Returns
LayoutSlide with specified type or null if no layouts found.

Implements Aspose::Slides::ILayoutSlideCollection.

◆ GetEnumerator()

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

◆ idx_get()

System::SharedPtr<ILayoutSlide> Aspose::Slides::LayoutSlideCollection::idx_get ( int32_t  index)
virtual

Returns the layout slide by index. Read-only LayoutSlide.

Implements Aspose::Slides::ILayoutSlideCollection.

◆ IndexOf()

int32_t Aspose::Slides::LayoutSlideCollection::IndexOf ( System::SharedPtr< ILayoutSlide value)
protected

◆ Insert()

void Aspose::Slides::LayoutSlideCollection::Insert ( int32_t  index,
System::SharedPtr< ILayoutSlide value 
)
protected

◆ Remove()

void Aspose::Slides::LayoutSlideCollection::Remove ( System::SharedPtr< ILayoutSlide value)
virtual

Removes a layout from the collection.

Parameters
valueThe layout slide to remove from the collection.
Exceptions
PptxEditExceptionThrown if layout is used in presentation (its HasDependingSlides property is true).

1) To avoid throwing of the PptxEditException check layout's HasDependingSlides property before. 2) You can use also ILayoutSlide::Remove() method to simplify code.

Implements Aspose::Slides::ILayoutSlideCollection.

◆ RemoveUnused()

void Aspose::Slides::LayoutSlideCollection::RemoveUnused ( )
virtual

Removes unused layout slides (layout slides whose HasDependingSlides is false).

Implements Aspose::Slides::ILayoutSlideCollection.