com.aspose.words

Class CustomXmlPartCollection

java.lang.Object

com.aspose.words.CustomXmlPartCollection

All Implemented Interfaces:

java.lang.Iterable

public class CustomXmlPartCollection
extends java.lang.Object
implements java.lang.Iterable

Represents a collection of Custom XML Parts. The items are CustomXmlPart objects.

To learn more, visit the Structured Document Tags or Content Control documentation article.

You do not normally need to create instances of this class. You can access custom XML data stored in a document via the Document.getCustomXmlParts() / Document.setCustomXmlParts(com.aspose.words.CustomXmlPartCollection) property.

See Also:

CustomXmlPart, Document.getCustomXmlParts(), Document.setCustomXmlParts(com.aspose.words.CustomXmlPartCollection)

Method Summary

Modifier and Type	Method and Description
void	add(CustomXmlPart part) Adds an item to the collection.
CustomXmlPart	add(java.lang.String id, java.lang.String xml) Creates a new XML part with the specified XML and adds it to the collection.
void	clear() Removes all elements from the collection.
CustomXmlPartCollection	deepClone() Makes a deep copy of this collection and its items.
CustomXmlPart	get(int index) Gets an item at the specified index.
CustomXmlPart	getById(java.lang.String id) Finds and returns a custom XML part by its identifier.
int	getCount() Gets the number of elements contained in the collection.
java.util.Iterator	iterator() Returns an iterator object that can be used to iterate over all items in the collection.
void	removeAt(int index) Removes an item at the specified index.
void	set(int index, CustomXmlPart value) Sets an item at the specified index.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getCount

public int getCount()

Gets the number of elements contained in the collection.

Returns:

The number of elements contained in the collection.

get

public CustomXmlPart get(int index)

Gets an item at the specified index.

Parameters:

index - Zero-based index of the item.

Returns:

An item at the specified index.

set

public void set(int index,
                CustomXmlPart value)

Sets an item at the specified index.

Parameters:

index - Zero-based index of the item.

value - An item at the specified index.

iterator

public java.util.Iterator iterator()

Returns an iterator object that can be used to iterate over all items in the collection.

Specified by:

iterator in interface java.lang.Iterable

add

public void add(CustomXmlPart part)

Adds an item to the collection.

Parameters:

part - The custom XML part to add.

add

public CustomXmlPart add(java.lang.String id,
                         java.lang.String xml)

Creates a new XML part with the specified XML and adds it to the collection.

Parameters:

id - Identifier of a new custom XML part.

xml - XML data of the part.

Returns:

Created custom XML part.

removeAt

public void removeAt(int index)

Removes an item at the specified index.

Parameters:

index - The zero based index.

clear

public void clear()

Removes all elements from the collection.

getById

public CustomXmlPart getById(java.lang.String id)

Finds and returns a custom XML part by its identifier.

Parameters:

id - Case-sensitive string that identifies the custom XML part.

Returns:

Returns null if a custom XML part with the specified identifier is not found.

deepClone

public CustomXmlPartCollection deepClone()

Makes a deep copy of this collection and its items.