com.aspose.slides

Class MasterSlideCollection

java.lang.Object

com.aspose.slides.DomObject<Presentation>

com.aspose.slides.MasterSlideCollection

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IMasterSlide>, com.aspose.ms.System.Collections.ICollection<IMasterSlide>, com.aspose.ms.System.Collections.IEnumerable<IMasterSlide>, IGenericCollection<IMasterSlide>, IMasterSlideCollection, java.lang.Iterable<IMasterSlide>

public final class MasterSlideCollection
extends DomObject<Presentation>
implements IMasterSlideCollection

Represents a collection of master slides.

Method Summary

Modifier and Type	Method and Description
IMasterSlide	addClone(IMasterSlide sourceMaster) Adds a copy of a specified master slide to the end of the collection.
void	copyTo(com.aspose.ms.System.Array array, int index) Copies all elements from the collection to the specified array.
IMasterSlide	get_Item(int index) Gets the element at the specified index.
java.lang.Object	getSyncRoot() Returns a synchronization root.
IMasterSlide	insertClone(int index, IMasterSlide sourceMaster) Inserts a copy of a specified master slide to specified position of the collection.
boolean	isSynchronized() Returns a value indicating whether access to the collection is synchronized (thread-safe).
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IMasterSlide>	iterator() Returns an enumerator that iterates through the collection.
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IMasterSlide>	iteratorJava() Returns a java iterator for the entire collection.
void	remove(IMasterSlide value) Removes the first occurrence of a specific object from the collection.
void	removeAt(int index) Removes the element at the specified index of the collection.
void	removeUnused(boolean ignorePreserveField) Removes unused master slides.
int	size() Gets the number of elements actually contained in the collection.

Methods inherited from class com.aspose.slides.DomObject

getParent_Immediate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

size

public final int size()

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

Specified by:

size in interface com.aspose.ms.System.Collections.ICollection<IMasterSlide>

get_Item

public final IMasterSlide get_Item(int index)

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

Specified by:

get_Item in interface IMasterSlideCollection

remove

public final void remove(IMasterSlide value)

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

Specified by:

remove in interface IMasterSlideCollection

Parameters:

value - The master slide to remove from the collection.

removeAt

public final void removeAt(int index)

Removes the element at the specified index of the collection.

Specified by:

removeAt in interface IMasterSlideCollection

Parameters:

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

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

Throws:

PptxEditException - Thrown if the master to remove is used in presentation (its HasDependingSlides property is true).

removeUnused

public final void removeUnused(boolean ignorePreserveField)

Removes unused master slides.

Specified by:

removeUnused in interface IMasterSlideCollection

Parameters:

ignorePreserveField - Determines, whether this method should remove unused master even if its MasterSlide.getPreserve()/MasterSlide.setPreserve(boolean) property is set to true.

addClone

public final IMasterSlide addClone(IMasterSlide sourceMaster)

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

Specified by:

addClone in interface IMasterSlideCollection

Parameters:

sourceMaster - Slide to clone.

Returns:

Added slide.

insertClone

public final IMasterSlide insertClone(int index,
                                      IMasterSlide sourceMaster)

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

 The following example shows how to clone master slide in another PowerPoint Presentation.
 
 // Instantiate Presentation class to load the source presentation file
 Presentation srcPres = new Presentation("CloneToAnotherPresentationWithMaster.pptx");
 try {
     // Instantiate Presentation class for destination presentation (where slide is to be cloned)
     Presentation destPres = new Presentation();
     try {
         // Instantiate ISlide from the collection of slides in source presentation along with
         // Master slide
         ISlide SourceSlide = srcPres.getSlides().get_Item(0);
         IMasterSlide SourceMaster = SourceSlide.getLayoutSlide().getMasterSlide();
         // Get Master Slides of destination presentation
         IMasterSlideCollection masters = destPres.getMasters();
         // Clone the desired master slide from the source presentation to the collection of masters in the
         // Destination presentation
         IMasterSlide iSlide = masters.addClone(SourceMaster);
         // Collection of slides in the destination presentation
         ISlideCollection slds = destPres.getSlides();
         // Clone source slide to destination slides collection.
         slds.addClone(SourceSlide, iSlide, true);
         // Save the destination presentation to disk
         destPres.save("CloneToAnotherPresentationWithMaster_out.pptx", SaveFormat.Pptx);
     } finally {
         if (destPres != null) destPres.dispose();
     }
 } finally {
     if (srcPres != null) srcPres.dispose();
 }
 
 

Specified by:

insertClone in interface IMasterSlideCollection

Parameters:

index - Index of new slide.

sourceMaster - Slide to clone.

Returns:

Inserted master slide.

copyTo

public final void copyTo(com.aspose.ms.System.Array array,
                         int index)

Copies all elements from the collection to the specified array.

Specified by:

copyTo in interface com.aspose.ms.System.Collections.ICollection<IMasterSlide>

Parameters:

array - Target array.

index - Starting index in the target array.

isSynchronized

public final boolean isSynchronized()

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

Specified by:

isSynchronized in interface com.aspose.ms.System.Collections.ICollection<IMasterSlide>

getSyncRoot

public final java.lang.Object getSyncRoot()

Returns a synchronization root. Read-only Object.

Specified by:

getSyncRoot in interface com.aspose.ms.System.Collections.ICollection<IMasterSlide>

iterator

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IMasterSlide> iterator()

Returns an enumerator that iterates through the collection.

Specified by:

iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IMasterSlide>

Specified by:

iterator in interface com.aspose.ms.System.Collections.IEnumerable<IMasterSlide>

Specified by:

iterator in interface java.lang.Iterable<IMasterSlide>

Returns:

A IGenericEnumerator that can be used to iterate through the collection.

iteratorJava

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IMasterSlide> iteratorJava()

Returns a java iterator for the entire collection.

Specified by:

iteratorJava in interface IGenericCollection<IMasterSlide>

Returns:

An Iterator for the entire collection.