SlideCollection

SlideCollection class

Represents a collection of a slides.

addClone

Name	Description
addClone (Slide)	Adds a copy of a specified slide to the end of the collection.

Parameters:

Name	Type	Description
sourceSlide	Slide	Slide to clone. When cloning a slide between different presentations slide’s master can be cloned too. Internal registry is used to track automatically cloned masters to prevent creation of multiple clones of the same master slide. Manual cloning of master slides will be neither prevented nor registered. If you need more control over cloning process use #addClone(ISlide,ILayoutSlide) or #addClone(ISlide,IMasterSlide,boolean) for cloning slides, IGlobalLayoutSlideCollection#addClone(ILayoutSlide) or IGlobalLayoutSlideCollection#addClone(ILayoutSlide,IMasterSlide) for cloning layouts and IMasterSlideCollection#addClone(IMasterSlide) for cloning masters.

Returns: Slide

addClone

Name	Description
addClone (Slide, Section)	Adds a copy of a specified slide to the end of the specified section.

Parameters:

Name	Type	Description
sourceSlide	Slide	Slide to clone.
section	Section	Section for a new slide.

Returns: Slide

Exception

Error	Condition
PptxEditException	When section parameter contains wrong or invalid value.

addClone

Name	Description
addClone (Slide, LayoutSlide)	Adds a copy of a specified slide to the end of the collection.

Parameters:

Name	Type	Description
sourceSlide	Slide	Slide to clone.
destLayout	LayoutSlide	Layout slide for a new slide.

Returns: Slide

addClone

Name

Description

addClone (Slide, MasterSlide, boolean)

Adds a copy of a specified source slide to the end of the collection. Appropriate layout will be selected automatically from the specified master (appropriate layout is the layout with the same Type or Name as of layout of the source slide). If there is no appropriate layout then layout of the source slide will be cloned (if allowCloneMissingLayout is true) or PptxEditException will be thrown (if allowCloneMissingLayout is false).

Parameters:

Name	Type	Description
sourceSlide	Slide	Slide to clone.
destMaster	MasterSlide	Master slide for a new slide.
allowCloneMissingLayout	boolean	If there is no appropriate layout in specified master then layout of the source slide will be cloned (if allowCloneMissingLayout is true) or PptxEditException will be thrown (if allowCloneMissingLayout is false).

Returns: Slide

Exception

Error	Condition
PptxEditException	Thrown if there is no appropriate layout in specified master and allowCloneMissingLayout is false.

addEmptySlide

Name	Description
addEmptySlide (LayoutSlide)	Adds a new empty slide to the end of the collection.

Parameters:

Name	Type	Description
layout	LayoutSlide	Layout for a slide.

Returns: Slide

addFromHtml

Name	Description
addFromHtml (String, HtmlExternalResolver, String)	Creates slides from HTML text and adds them to the end of the collection.

Parameters:

Name	Type	Description
htmlText	String	Html to add.
resolver	HtmlExternalResolver	A callback object used to fetch external objects. If this parameter is null all external objects will be ignored.
uri	String	An URI of the specified HTML. Used to resolve relative links.

Returns: Slide

addFromHtml

Name	Description
addFromHtml (String, ExternalResourceResolver, String)	Creates slides from HTML text and adds them to the end of the collection.

Parameters:

Name	Type	Description
htmlText	String	Html to add.
resolver	ExternalResourceResolver	A callback object used to fetch external objects. If this parameter is null all external objects will be ignored.
uri	String	An URI of the specified HTML. Used to resolve relative links.

Returns: Slide

addFromHtml

Name	Description
addFromHtml (String)	Creates slides from HTML text and adds them to the end of the collection.

Parameters:

Name	Type	Description
htmlText	String	Html to add.

Returns: Slide

addFromHtml

Name	Description
addFromHtml (InputStream, HtmlExternalResolver, String)	Creates slides from HTML text and adds them to the end of the collection.

Parameters:

Name	Type	Description
htmlStream	InputStream	A Stream object which will be used as a source of a HTML file.
resolver	HtmlExternalResolver	A callback object used to fetch external objects. If this parameter is null all external objects will be ignored.
uri	String	An URI of the specified HTML. Used to resolve relative links.

Returns: Slide

addFromHtml

Name	Description
addFromHtml (InputStream, ExternalResourceResolver, String)	Creates slides from HTML text and adds them to the end of the collection.

Parameters:

Name	Type	Description
htmlStream	InputStream	A Stream object which will be used as a source of a HTML file.
resolver	ExternalResourceResolver	A callback object used to fetch external objects. If this parameter is null all external objects will be ignored.
uri	String	An URI of the specified HTML. Used to resolve relative links.

Returns: Slide

addFromHtml

Name	Description
addFromHtml (InputStream)	Creates slides from HTML text and adds them to the end of the collection.

Parameters:

Name	Type	Description
htmlStream	InputStream	A Stream object which will be used as a source of a HTML file.

Returns: Slide

addFromPdf

Name	Description
addFromPdf (String)	Creates slides from the PDF document and adds them to the end of the collection.

Parameters:

Name	Type	Description
path	String	A path to the PDF document

Returns: Slide

addFromPdf

Name	Description
addFromPdf (String, PdfImportOptions)	Creates slides from the PDF document and adds them to the end of the collection considering the pdf import options.

Parameters:

Name	Type	Description
path	String	A path to the PDF document
pdfImportOptions	PdfImportOptions	Options for pdf import

Returns: Slide

addFromPdf

Name	Description
addFromPdf (InputStream)	Creates slides from the PDF document and adds them to the end of the collection.

Parameters:

Name	Type	Description
pdfStream	InputStream	A stream which will be used as a source of the PDF document

Returns: Slide

addFromPdf

Name	Description
addFromPdf (InputStream, PdfImportOptions)	Creates slides from the PDF document and adds them to the end of the collection.

Parameters:

Name	Type	Description
pdfStream	InputStream	A stream which will be used as a source of the PDF document
pdfImportOptions	PdfImportOptions	Options for pdf import

Returns: Slide

getSyncRoot

Name	Description
getSyncRoot ()	Returns a synchronization root. Read-only Object.

Returns: Object

get_Item

Name	Description
get_Item (int)	Gets the element at the specified index. Read-only Slide.

Returns: Slide

indexOf

Name	Description
indexOf (Slide)	Returns an index of the specified slide in the collection.

Parameters:

Name	Type	Description
slide	Slide	Slide to find.

Returns: int

insertClone

Name	Description
insertClone (int, Slide)	Inserts a copy of a specified slide to specified position of the collection.

Parameters:

Name	Type	Description
index	int	Index of new slide.
sourceSlide	Slide	Slide to clone. When cloning a slide between different presentations slide’s master can be cloned too. Internal registry is used to track automatically cloned masters to prevent creation of multiple clones of the same master slide. Manual cloning of master slides will be neither prevented nor registered. If you need more control over cloning process use #insertClone(int,ISlide,ILayoutSlide) or #insertClone(int,ISlide,IMasterSlide,boolean) for cloning slides and IMasterSlideCollection#addClone(IMasterSlide) for cloning masters.

Returns: Slide

insertClone

Name	Description
insertClone (int, Slide, LayoutSlide)	Inserts a copy of a specified slide to specified position of the collection.

Parameters:

Name	Type	Description
index	int	Index of new slide.
sourceSlide	Slide	Slide to clone.
destLayout	LayoutSlide	Layout slide for a new slide.

Returns: Slide

insertClone

Name

Description

insertClone (int, Slide, MasterSlide, boolean)

Inserts a copy of a specified source slide to specified position of the collection. Appropriate layout will be selected automatically from the specified master (appropriate layout is the layout with the same Type or Name as of layout of the source slide). If there is no appropriate layout then layout of the source slide will be cloned (if allowCloneMissingLayout is true) or PptxEditException will be thrown (if allowCloneMissingLayout is false).

Parameters:

Name	Type	Description
index	int	Index of new slide.
sourceSlide	Slide	Slide to clone.
destMaster	MasterSlide	Master slide for a new slide.
allowCloneMissingLayout	boolean	If there is no appropriate layout in specified master then layout of the source slide will be cloned (if allowCloneMissingLayout is true) or PptxEditException will be thrown (if allowCloneMissingLayout is false).

Returns: Slide

Exception

Error	Condition
PptxEditException	Thrown if there is no appropriate layout in specified master and allowCloneMissingLayout is false.

insertEmptySlide

Name	Description
insertEmptySlide (int, LayoutSlide)	Inserts a copy of a specified slide to specified position of the collection.

Parameters:

Name	Type	Description
index	int	Index of a new slide.
layout	LayoutSlide	Layout for a slide.

Returns: Slide

insertFromHtml

Name	Description
insertFromHtml (int, String, HtmlExternalResolver, String)	Creates slides from HTML text and inserts them to the collection at the specified position.

Parameters:

Name	Type	Description
index	int	Position to insert.
htmlText	String	Html to add.
resolver	HtmlExternalResolver	A callback object used to fetch external objects. If this parameter is null all external objects will be ignored.
uri	String	An URI of the specified HTML. Used to resolve relative links.

Returns: Slide

insertFromHtml

Name	Description
insertFromHtml (int, String, ExternalResourceResolver, String)	Creates slides from HTML text and inserts them to the collection at the specified position.

Parameters:

Name	Type	Description
index	int	Position to insert.
htmlText	String	Html to add.
resolver	ExternalResourceResolver	A callback object used to fetch external objects. If this parameter is null all external objects will be ignored.
uri	String	An URI of the specified HTML. Used to resolve relative links.

Returns: Slide

insertFromHtml

Name	Description
insertFromHtml (int, String)	Creates slides from HTML text and inserts them to the collection at the specified position.

Parameters:

Name	Type	Description
index	int	Position to insert.
htmlText	String	Html to add.

Returns: Slide

insertFromHtml

Name	Description
insertFromHtml (int, InputStream, HtmlExternalResolver, String)	Creates slides from HTML text and inserts them to the collection at the specified position.

Parameters:

Name	Type	Description
index	int	Position to insert.
htmlStream	InputStream	A Stream object which will be used as a source of a HTML file.
resolver	HtmlExternalResolver	A callback object used to fetch external objects. If this parameter is null all external objects will be ignored.
uri	String	An URI of the specified HTML. Used to resolve relative links.

Returns: Slide

insertFromHtml

Name	Description
insertFromHtml (int, InputStream, ExternalResourceResolver, String)	Creates slides from HTML text and inserts them to the collection at the specified position.

Parameters:

Name	Type	Description
index	int	Position to insert.
htmlStream	InputStream	A Stream object which will be used as a source of a HTML file.
resolver	ExternalResourceResolver	A callback object used to fetch external objects. If this parameter is null all external objects will be ignored.
uri	String	An URI of the specified HTML. Used to resolve relative links.

Returns: Slide

insertFromHtml

Name	Description
insertFromHtml (int, InputStream)	Creates slides from HTML text and inserts them to the collection at the specified position.

Parameters:

Name	Type	Description
index	int	Position to insert.
htmlStream	InputStream	A Stream object which will be used as a source of a HTML file.

Returns: Slide

isSynchronized

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

Returns: boolean

iterator

Name	Description
iterator ()	Returns an enumerator that iterates through the collection.

Returns:

iteratorJava

Name	Description
iteratorJava ()	Returns a java iterator for the entire collection.

Returns:

remove

Name	Description
remove (Slide)	Removes the first occurrence of a specific object from the collection.

Parameters:

Name	Type	Description
value	Slide	The slide to remove from the collection.

Returns: void

removeAt

Name	Description
removeAt (int)	Removes the element at the specified index of the collection.

Parameters:

Name	Type	Description
index	int	The zero-based index of the element to remove.

Returns: void

Exception

Error	Condition
ArgumentOutOfRangeException	When index parameter contains wrong section number.

reorder

Name	Description
reorder (int, Slide)	Moves slide from the collection to the specified position.

Parameters:

Name	Type	Description
index	int	Target index.
slide	Slide	Slide to move.

Returns: void

reorder

Name	Description
reorder (int, com.aspose.slides.ISlide[])	Moves slides from the collection to the specified position. Slides will be placed starting from index in order they appear in list.

Parameters:

Name	Type	Description
index	int	Target index.
slides	com.aspose.slides.ISlide[]	Slides to move.

Returns: void

size

Name	Description
size ()	Gets the number of elements actually contained in the collection. Read-only int.

Returns: int

toArray

Name	Description
toArray ()	Creates and returns an array with all slides in it.

Returns: Slide

toArray

Name	Description
toArray (int, int)	Creates and returns an array with all slides from the specified range in it.

Parameters:

Name	Type	Description
startIndex	int	An index of a first slide to add.
count	int	A number of slides to add.

Returns: Slide