com.aspose.slides

Class CustomXmlPartCollection

java.lang.Object

com.aspose.slides.CustomXmlPartCollection

All Implemented Interfaces:

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

public class CustomXmlPartCollection
extends java.lang.Object
implements ICustomXmlPartCollection

Represents collection of custom xml parts.

Method Summary

Modifier and Type	Method and Description
ICustomXmlPart	add(byte[] xmlData) Adds new custom xml part.
ICustomXmlPart	add(java.io.InputStream inputStream) Adds new custom xml part.
ICustomXmlPart	add(java.lang.String xmlString) Adds new custom xml part.
void	clear() Removes all items from the collection.
void	copyTo(com.aspose.ms.System.Array array, int index) Copy to specified array.
ICustomXmlPart	get_Item(int index) Returns the element at the specified index.
com.aspose.slides.IDOMObject	getParent_Immediate() Returns Parent_Immediate object.
java.lang.Object	getSyncRoot() Returns a synchronization root.
boolean	isSynchronized() Returns a value indicating whether access to the collection is synchronized (thread-safe).
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<ICustomXmlPart>	iterator() Returns an enumerator that iterates through the collection.
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<ICustomXmlPart>	iteratorJava() Returns a java iterator for the entire collection.
boolean	remove(ICustomXmlPart item) Removes the first occurrence of a specific object from the collection.
void	removeAt(int index) Removes custom xml part at the specified index.
int	size() Returns count of custom xml parts in the collection.

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

get_Item

public final ICustomXmlPart get_Item(int index)

Returns the element at the specified index.

Specified by:

get_Item in interface ICustomXmlPartCollection

Parameters:

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

Returns:

The element at the specified index.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - index is less than 0.-or-index is equal to or greater than Count

size

public final int size()

Returns count of custom xml parts in the collection. Read-only int.

Specified by:

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

add

public final ICustomXmlPart add(java.lang.String xmlString)

Adds new custom xml part.

Specified by:

add in interface ICustomXmlPartCollection

Parameters:

xmlString - The xml string of new part to be added.

Returns:

Created custom xml part.

Throws:

com.aspose.ms.System.ArgumentNullException - xmlString is null.

com.aspose.ms.System.ArgumentException - xmlString is empty or xml-data is invalid.

add

public final ICustomXmlPart add(byte[] xmlData)

Adds new custom xml part.

Specified by:

add in interface ICustomXmlPartCollection

Parameters:

xmlData - The xml data of new part to be added.

Returns:

Created custom xml part.

Throws:

com.aspose.ms.System.ArgumentNullException - xmlData is null.

com.aspose.ms.System.ArgumentException - xmlData is empty or invalid.

add

public final ICustomXmlPart add(java.io.InputStream inputStream)

Adds new custom xml part.

Specified by:

add in interface ICustomXmlPartCollection

Parameters:

inputStream - The inputStream with xml data of new part to be added.

Returns:

Created custom xml part.

Throws:

com.aspose.ms.System.ArgumentNullException - inputStream is null.

com.aspose.ms.System.ArgumentException - Data in inputStream is empty or invalid.

removeAt

public final void removeAt(int index)

Removes custom xml part at the specified index.

Specified by:

removeAt in interface ICustomXmlPartCollection

Parameters:

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

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - index is less than 0.-or-index is equal to or greater than Count

remove

public final boolean remove(ICustomXmlPart item)

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

Specified by:

remove in interface ICustomXmlPartCollection

Parameters:

item - The custom xml part to remove.

Returns:

true if item is successfully removed; otherwise, false.

Throws:

com.aspose.ms.System.ArgumentNullException - item is null.

clear

public final void clear()

Removes all items from the collection.

Specified by:

clear in interface ICustomXmlPartCollection

copyTo

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

Copy to specified array.

Specified by:

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

Parameters:

array - Array to copy to.

index - Index to begin copying.

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

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

iterator

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

Returns an enumerator that iterates through the collection.

Specified by:

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

Specified by:

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

Specified by:

iterator in interface java.lang.Iterable<ICustomXmlPart>

Returns:

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

iteratorJava

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

Returns a java iterator for the entire collection.

Specified by:

iteratorJava in interface IGenericCollection<ICustomXmlPart>

Returns:

An Iterator for the entire collection.

getParent_Immediate

public final com.aspose.slides.IDOMObject getParent_Immediate()

Returns Parent_Immediate object. Read-only IDOMObject.