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

See Also:

CustomXmlPart, Document.CustomXmlParts

CustomXmlPartCollection

public CustomXmlPartCollection()

public int getCount()

Gets the number of elements contained in the collection.

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.

public void add(CustomXmlPart part)

Adds an item to the collection.

Parameters:

part - The custom XML part to 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.

Example:

Shows how to create structured document tag with a custom XML data.

Document doc = new Document();
// Add test XML data part to the collection.
CustomXmlPart xmlPart = doc.getCustomXmlParts().add(UUID.randomUUID().toString(), "<root><text>Hello, World!</text></root>");

StructuredDocumentTag sdt = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.BLOCK);
sdt.getXmlMapping().setMapping(xmlPart, "/root[1]/text[1]", "");

doc.getFirstSection().getBody().appendChild(sdt);

doc.save(getMyDir() + "\\Artifacts\\SDT.CustomXml.docx");

public void clear()

Removes all elements from the collection.

public CustomXmlPartCollection deepClone()

Makes a deep copy of this collection and its items.

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.

public java.util.Iterator<CustomXmlPart> iterator()

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

public void removeAt(int index)

Removes an item at the specified index.

Parameters:

index - The zero based index.