com.aspose.words
Class CustomXmlPartCollection

java.lang.Object
    extended by com.aspose.words.CustomXmlPartCollection
All Implemented Interfaces:
java.lang.Iterable

public class CustomXmlPartCollection 
extends java.lang.Object

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

You do not normally need to create instances of this class. You can access custom XML data stored in a document via the Document.CustomXmlParts property.

See Also:
CustomXmlPart, Document.CustomXmlParts

Constructor Summary
CustomXmlPartCollection()
           Initializes an instance of this class.
 
Property Getters/Setters Summary
intgetCount()
           Gets the number of elements contained in the collection.
CustomXmlPartget(int index)
voidset(int index, CustomXmlPart value)
           Gets or sets an item at the specified index.
 
Method Summary
voidadd(CustomXmlPart part)
           Adds an item to the collection.
voidclear()
           Removes all elements from the collection.
CustomXmlPartCollectiondeepClone()
           Makes a deep copy of this collection and its items.
CustomXmlPartgetById(java.lang.String id)
           Finds and returns a custom XML part by its identifier.
java.util.Iteratoriterator()
           Returns an iterator object that can be used to iterate over all items in the collection.
voidremoveAt(int index)
           Removes an item at the specified index.
 

Constructor Detail

CustomXmlPartCollection

public CustomXmlPartCollection()
Initializes an instance of this class.

Property Getters/Setters Detail

getCount

public int getCount()
Gets the number of elements contained in the collection.

get/set

public CustomXmlPart get(int index) / public void set(int index, CustomXmlPart value)
Gets or sets an item at the specified index.
Parameters:
index - Zero-based index of the item.

Method Detail

add

public void add(CustomXmlPart part)
Adds an item to the collection.
Parameters:
part - The custom XML part to add.

clear

public void clear()
Removes all elements from the collection.

deepClone

public CustomXmlPartCollection deepClone()
Makes a deep copy of this collection and its items.

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.

iterator

public java.util.Iterator iterator()
Returns an iterator object that can be used to iterate over all items in the collection.

removeAt

public void removeAt(int index)
Removes an item at the specified index.
Parameters:
index - The zero based index.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.