com.spire.doc.documents.markup
Class CustomXmlPartCollection

java.lang.Object
  com.spire.doc.documents.markup.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 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.getCustomXmlParts() property. see also CustomXmlPart. see also Document.getCustomXmlParts()

Constructor Summary

CustomXmlPartCollection(Document doc)
Initializes an instance of this class.

Method Summary

void	add(CustomXmlPart part) Adds an item 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.

Constructor Detail

CustomXmlPartCollection

public CustomXmlPartCollection(Document doc)

Initializes an instance of this class.

Parameters:

doc - Document

Method Detail

getCount

public int getCount()

Gets the number of elements contained in the collection.

Returns:

int

get

public CustomXmlPart get(int index)

Gets an item at the specified index.

Parameters:

index - Zero-based index of the item.

Returns:

CustomXmlPart

set

public void set(int index,
                CustomXmlPart value)

Sets an item at the specified index.

Parameters:

index - Zero-based index of the item.

value - CustomXmlPart

iterator

public java.util.Iterator iterator()

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

Returns:

Iterator

add

public void add(CustomXmlPart part)

Adds an item to the collection.

Parameters:

part - The custom XML part to add.

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.

Returns:

CustomXmlPartCollection