Aspose::Slides::MasterSlideCollection Class Referencefinal

Represents a collection of master slides. More...

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

Public Types

using iterator_holder_type = System::Collections::Generic::List< System::SharedPtr< IMasterSlide > >
 A collection type whose iterator types is used as iterator types in the current collection. More...
 
using iterator = typename iterator_holder_type::iterator
 Iterator type. More...
 
using const_iterator = typename iterator_holder_type::const_iterator
 Const iterator type. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< T >
typedef IEnumerator< T > IEnumeratorType
 Enumerator type. More...
 
using ValueType = T
 
using iterator = EnumeratorBasedIterator< T, IEnumerator< T > >
 
using const_iterator = iterator
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

int32_t get_Count () override
 Gets the number of elements actually contained in the collection. Read-only int32_t. More...
 
bool get_IsSynchronized () override
 Returns a value indicating whether access to the collection is synchronized (thread-safe). Read-only bool. More...
 
System::SharedPtr< System::Objectget_SyncRoot () override
 Returns a synchronization root. Read-only System::Object. More...
 
System::SharedPtr< IMasterSlideidx_get (int32_t index) override
 Gets the element at the specified index. Read-only MasterSlide. More...
 
void Remove (System::SharedPtr< IMasterSlide > value) override
 Removes the first occurrence of a specific object from the collection. More...
 
void RemoveAt (int32_t index) override
 Removes the element at the specified index of the collection. More...
 
void RemoveUnused (bool ignorePreserveField) override
 Removes unused master slides. More...
 
System::SharedPtr< IMasterSlideAddClone (System::SharedPtr< IMasterSlide > sourceMaster) override
 Adds a copy of a specified master slide to the end of the collection. Linked layout slides will be copied too. More...
 
System::SharedPtr< IMasterSlideInsertClone (int32_t index, System::SharedPtr< IMasterSlide > sourceMaster) override
 Inserts a copy of a specified master slide to specified position of the collection. Linked layout slides will be copied too. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< IMasterSlide >> array, int32_t index) override
 Copies all elements from the collection to the specified array. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< IMasterSlide > > > GetEnumerator () override
 Returns an enumerator that iterates through the collection. More...
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. 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...
 
- Public Member Functions inherited from Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::IMasterSlide > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Slides::IMasterSlide > > 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 >
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...
 
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...
 

Protected Member Functions

virtual ~MasterSlideCollection ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. More...
 

Additional Inherited Members

- 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...
 

Detailed Description

Represents a collection of master slides.

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ iterator_holder_type

A collection type whose iterator types is used as iterator types in the current collection.

Constructor & Destructor Documentation

◆ ~MasterSlideCollection()

virtual Aspose::Slides::MasterSlideCollection::~MasterSlideCollection ( )
protectedvirtual

Member Function Documentation

◆ AddClone()

System::SharedPtr<IMasterSlide> Aspose::Slides::MasterSlideCollection::AddClone ( System::SharedPtr< IMasterSlide sourceMaster)
overridevirtual

Adds a copy of a specified master slide to the end of the collection. Linked layout slides will be copied too.

Parameters
sourceMasterSlide to clone.
Returns
Added slide.

Implements Aspose::Slides::IMasterSlideCollection.

◆ begin() [1/2]

const_iterator Aspose::Slides::MasterSlideCollection::begin ( ) const
noexcept

Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection.

Returns
An iterator pointing to the first element (if any) of the const-qualified instance of the collection

◆ begin() [2/2]

iterator Aspose::Slides::MasterSlideCollection::begin ( )
noexcept

Gets iterator pointing to the first element (if any) of the collection.

Returns
An iterator pointing to the first element (if any) of the collection

◆ cbegin()

const_iterator Aspose::Slides::MasterSlideCollection::cbegin ( ) const
noexcept

Gets iterator pointing to the first const-qualified element (if any) of the collection.

Returns
An iterator pointing to the first const-qualified element (if any) of the collection

◆ cend()

const_iterator Aspose::Slides::MasterSlideCollection::cend ( ) const
noexcept

Gets iterator pointing right after the last const-qualified element (if any) of the collection.

Returns
An iterator pointing right after the last const-qualified element (if any) of the collection

◆ CopyTo()

void Aspose::Slides::MasterSlideCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< IMasterSlide >>  array,
int32_t  index 
)
override

Copies all elements from the collection to the specified array.

Parameters
arrayTarget array.
indexStarting index in the target array.

◆ end() [1/2]

const_iterator Aspose::Slides::MasterSlideCollection::end ( ) const
noexcept

Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection.

Returns
An iterator pointing right after the last element (if any) of the const-qualified instance of the collection

◆ end() [2/2]

iterator Aspose::Slides::MasterSlideCollection::end ( )
noexcept

Gets iterator pointing right after the last element (if any) of the collection.

Returns
An iterator pointing right after the last element (if any) of the collection

◆ get_Count()

int32_t Aspose::Slides::MasterSlideCollection::get_Count ( )
overridevirtual

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

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

◆ get_IsSynchronized()

bool Aspose::Slides::MasterSlideCollection::get_IsSynchronized ( )
overridevirtual

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

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

◆ get_SyncRoot()

System::SharedPtr<System::Object> Aspose::Slides::MasterSlideCollection::get_SyncRoot ( )
overridevirtual

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<IMasterSlide> > > Aspose::Slides::MasterSlideCollection::GetEnumerator ( )
overridevirtual

Returns an enumerator that iterates through the collection.

Returns
A IEnumerator that can be used to iterate through the collection.

Implements System::Collections::Generic::IEnumerable< T >.

◆ idx_get()

System::SharedPtr<IMasterSlide> Aspose::Slides::MasterSlideCollection::idx_get ( int32_t  index)
overridevirtual

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

Implements Aspose::Slides::IMasterSlideCollection.

◆ InsertClone()

System::SharedPtr<IMasterSlide> Aspose::Slides::MasterSlideCollection::InsertClone ( int32_t  index,
System::SharedPtr< IMasterSlide sourceMaster 
)
overridevirtual

Inserts a copy of a specified master slide to specified position of the collection. Linked layout slides will be copied too.

Parameters
indexIndex of new slide.
sourceMasterSlide to clone.
Returns
Inserted master slide.

Implements Aspose::Slides::IMasterSlideCollection.

◆ Remove()

void Aspose::Slides::MasterSlideCollection::Remove ( System::SharedPtr< IMasterSlide value)
overridevirtual

Removes the first occurrence of a specific object from the collection.

Parameters
valueThe master slide to remove from the collection.

Implements Aspose::Slides::IMasterSlideCollection.

◆ RemoveAt()

void Aspose::Slides::MasterSlideCollection::RemoveAt ( int32_t  index)
overridevirtual

Removes the element at the specified index of the collection.

Parameters
indexThe zero-based index of the element to remove.
Exceptions
PptxEditExceptionThrown if the master to remove is used in presentation (its HasDependingSlides property is true).

To avoid throwing of the PptxEditException check master's HasDependingSlides property before.

Implements Aspose::Slides::IMasterSlideCollection.

◆ RemoveUnused()

void Aspose::Slides::MasterSlideCollection::RemoveUnused ( bool  ignorePreserveField)
overridevirtual

Removes unused master slides.

Parameters
ignorePreserveFieldDetermines, whether this method should remove unused master even if its MasterSlide::set_Preserve() property is set to true.

Implements Aspose::Slides::IMasterSlideCollection.