Represents a collections of all layout slides of defined master slide. Extends ILayoutSlideCollection interface with methods for adding/inserting/removing/cloning layout slides in context of the individual collections of master's layout slides. More...

Inherits Aspose::Slides::ILayoutSlideCollection.

Inherited by Aspose::Slides::MasterLayoutSlideCollection.

Public Member Functions

virtual System::SharedPtr< ILayoutSlide > AddClone (System::SharedPtr< ILayoutSlide > sourceLayout)=0

Adds a copy of a specified layout slide to the end of the collection. More...

virtual System::SharedPtr< ILayoutSlide > InsertClone (int32_t index, System::SharedPtr< ILayoutSlide > sourceLayout)=0

Inserts a copy of a specified layout slide to specified position of the collection. More...

virtual System::SharedPtr< ILayoutSlide > Add (SlideLayoutType layoutType, System::String layoutName)=0

Adds a new layout slide to the end of the collection. More...

virtual System::SharedPtr< ILayoutSlide > Insert (int32_t index, SlideLayoutType layoutType, System::String layoutName)=0

Inserts a new layout slide to specified position of the collection. More...

virtual void RemoveAt (int32_t index)=0

Removes the element at the specified index of the collection. More...

virtual void Reorder (int32_t index, System::SharedPtr< ILayoutSlide > layoutSlide)=0

Moves layout slide from the collection to the specified position. More...

Public Member Functions inherited from Aspose::Slides::ILayoutSlideCollection

virtual System::SharedPtr< ILayoutSlide > idx_get (int32_t index)=0

Returns the layout slide by index. Read-only ILayoutSlide. More...

virtual System::SharedPtr< ILayoutSlide > GetByType (SlideLayoutType type)=0

Returns the first layout slide of specified type.

Parameters

type	A type of layout slide to find.

Returns: ILayoutSlide with specified type or null if no layouts found.

More...

virtual void Remove (System::SharedPtr< ILayoutSlide > value)=0

Removes a layout from the collection. More...

virtual void RemoveUnused ()=0

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

Public Member Functions inherited from Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::ILayoutSlide > >

virtual int32_t get_Count ()=0

Returns the number of behaviors in a collection. Read-only int32_t. More...

virtual System::SharedPtr< System::Object > get_SyncRoot ()=0

Returns a synchronization root. Read-only 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::ILayoutSlide > > 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< System::SharedPtr< Aspose::Slides::ILayoutSlide > >

virtual SharedPtr< IEnumerator< System::SharedPtr< Aspose::Slides::ILayoutSlide > > > GetEnumerator ()=0

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

Object & operator= (Object const &x)

Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object * SharedRefAdded ()

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 TypeInfo & GetType () 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)

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< Object >	ptr
	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 TypeInfo &	Type ()
	Impleemnts C# typeof(System.Object) construct. More...

Detailed Description

Represents a collections of all layout slides of defined master slide. Extends ILayoutSlideCollection interface with methods for adding/inserting/removing/cloning layout slides in context of the individual collections of master's layout slides.

Member Function Documentation

◆ Add()

virtual System::SharedPtr<ILayoutSlide> Aspose::Slides::IMasterLayoutSlideCollection::Add	(	SlideLayoutType	layoutType,
		System::String	layoutName
	)

pure virtual

Adds a new layout slide to the end of the collection.

Parameters

layoutType Layout type for a new layout. Supported layout types: Title, TitleOnly, Blank, TitleAndObject, VerticalText, VerticalTitleAndText, TwoObjects, SectionHeader, TwoTextAndTwoObjects, TitleObjectAndCaption, PictureAndCaption, Custom. Other layout types are not supported now: Text, TwoColumnText, Table, TextAndChart, ChartAndText, Diagram, Chart, TextAndClipArt, ClipArtAndText, TextAndObject, ObjectAndText, Object, TextAndMedia, MediaAndText, ObjectOverText, TextOverObject, TextAndTwoObjects, TwoObjectsAndText, TwoObjectsOverText, FourObjects, ClipArtAndVerticalText, VerticalTitleAndTextOverChart, ObjectAndTwoObject, TwoObjectsAndObject.

layoutName Name for a new layout. If passed name is already in use the ArgumentException will be thrown. If null parameter is passed then name genarated atomatically in regards to passed layout type (for example "Title Slide" or "1_Title Slide", "2_..", etc.).

Exceptions

NotImplementedException Thrown if unsupported value of parameter layoutType is passed. Layout types that are not supported now: Text, TwoColumnText, Table, TextAndChart, ChartAndText, Diagram, Chart, TextAndClipArt, ClipArtAndText, TextAndObject, ObjectAndText, Object, TextAndMedia, MediaAndText, ObjectOverText, TextOverObject, TextAndTwoObjects, TwoObjectsAndText, TwoObjectsOverText, FourObjects, ClipArtAndVerticalText, VerticalTitleAndTextOverChart, ObjectAndTwoObject, TwoObjectsAndObject.

ArgumentException Thrown if layout name value layoutName is already in use in this collection of the layouts.

1) Added layout for value SlideLayoutType.Custom of layoutType contains no placeholders and no shapes. 2) Analogue of this method is method IGlobalLayoutSlideCollection::Add(IMasterSlide, SlideLayoutType, string) accessed with IPresentation::LayoutSlides property.

Returns: Added slide.

Implemented in Aspose::Slides::MasterLayoutSlideCollection.

◆ AddClone()

virtual System::SharedPtr<ILayoutSlide> Aspose::Slides::IMasterLayoutSlideCollection::AddClone ( System::SharedPtr< ILayoutSlide > sourceLayout )

pure virtual

Adds a copy of a specified layout slide to the end of the collection.

Parameters

sourceLayout Slide to clone.

Returns: Added slide.

1) New layout will be linked with parent master slide for this layout slides collection. So this is analogue of copy/paste with "Use Destination Theme" option in PowerPoint. 2) Analogue of this method is method IGlobalLayoutSlideCollection::AddClone(ILayoutSlide, IMasterSlide) accessed with IPresentation::LayoutSlides property.

Implemented in Aspose::Slides::MasterLayoutSlideCollection.

◆ Insert()

virtual System::SharedPtr<ILayoutSlide> Aspose::Slides::IMasterLayoutSlideCollection::Insert	(	int32_t	index,
		SlideLayoutType	layoutType,
		System::String	layoutName
	)

pure virtual

Inserts a new layout slide to specified position of the collection.

Parameters

index	Index of new slide.
layoutType	Layout type for a new layout. Supported layout types: Title, TitleOnly, Blank, TitleAndObject, VerticalText, VerticalTitleAndText, TwoObjects, SectionHeader, TwoTextAndTwoObjects, TitleObjectAndCaption, PictureAndCaption, Custom. Other layout types are not supported now: Text, TwoColumnText, Table, TextAndChart, ChartAndText, Diagram, Chart, TextAndClipArt, ClipArtAndText, TextAndObject, ObjectAndText, Object, TextAndMedia, MediaAndText, ObjectOverText, TextOverObject, TextAndTwoObjects, TwoObjectsAndText, TwoObjectsOverText, FourObjects, ClipArtAndVerticalText, VerticalTitleAndTextOverChart, ObjectAndTwoObject, TwoObjectsAndObject.
layoutName	Name for a new layout. If passed name is already in use the ArgumentException will be thrown. If null parameter is passed then name genarated atomatically in regards to passed layout type (for example "Title Slide" or "1_Title Slide", "2_..", etc.).

Exceptions

NotImplementedException Thrown if unsupported value of parameter layoutType is passed. Layout types that are not supported now: Text, TwoColumnText, Table, TextAndChart, ChartAndText, Diagram, Chart, TextAndClipArt, ClipArtAndText, TextAndObject, ObjectAndText, Object, TextAndMedia, MediaAndText, ObjectOverText, TextOverObject, TextAndTwoObjects, TwoObjectsAndText, TwoObjectsOverText, FourObjects, ClipArtAndVerticalText, VerticalTitleAndTextOverChart, ObjectAndTwoObject, TwoObjectsAndObject.

ArgumentException Thrown if layout name value layoutName is already in use in this collection of the layouts.

Inserted layout for value SlideLayoutType.Custom of layoutType contains no placeholders and no shapes.

Returns: Inserted slide.

Implemented in Aspose::Slides::MasterLayoutSlideCollection.

◆ InsertClone()

virtual System::SharedPtr<ILayoutSlide> Aspose::Slides::IMasterLayoutSlideCollection::InsertClone	(	int32_t	index,
		System::SharedPtr< ILayoutSlide >	sourceLayout
	)

pure virtual

Inserts a copy of a specified layout slide to specified position of the collection.

Parameters

index	Index of new slide.
sourceLayout	Slide to clone.

New layout will be linked with parent master slide for this layout slides collection. So this is analogue of copy/paste with "Use Destination Theme" option in PowerPoint.

Returns: Inserted slide.

Implemented in Aspose::Slides::MasterLayoutSlideCollection.

◆ RemoveAt()

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

pure virtual

Removes the element at the specified index of the collection.

Parameters

index The zero-based index of the element to remove.

Exceptions

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

Implemented in Aspose::Slides::MasterLayoutSlideCollection.

◆ Reorder()

virtual void Aspose::Slides::IMasterLayoutSlideCollection::Reorder	(	int32_t	index,
		System::SharedPtr< ILayoutSlide >	layoutSlide
	)

pure virtual

Moves layout slide from the collection to the specified position.

Parameters

index	Target index.
layoutSlide	Slide to move.

Implemented in Aspose::Slides::MasterLayoutSlideCollection.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Add()

◆ AddClone()

◆ Insert()

◆ InsertClone()

◆ RemoveAt()

◆ Reorder()