public class CustomPartCollection
extends java.lang.Object
implements java.lang.Iterable
CustomPart objects.
To learn more, visit the Structured Document Tags or Content Control documentation article.
Remarks:
You do not normally need to create instances of this class. You access custom parts related to the OOXML package via the Document.getPackageCustomParts() / Document.setPackageCustomParts(com.aspose.words.CustomPartCollection) property.
Examples:
Shows how to access a document's arbitrary custom parts collection.
Document doc = new Document(getMyDir() + "Custom parts OOXML package.docx");
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
// Clone the second part, then add the clone to the collection.
CustomPart clonedPart = doc.getPackageCustomParts().get(1).deepClone();
doc.getPackageCustomParts().add(clonedPart);
Assert.assertEquals(3, doc.getPackageCustomParts().getCount());
// Enumerate over the collection and print every part.
Iterator<CustomPart> enumerator = doc.getPackageCustomParts().iterator();
int index = 0;
while (enumerator.hasNext()) {
CustomPart customPart = enumerator.next();
System.out.println(MessageFormat.format("Part index {0}:", index));
System.out.println(MessageFormat.format("\tName: {0}", customPart.getName()));
System.out.println(MessageFormat.format("\tContentType: {0}", customPart.getContentType()));
System.out.println(MessageFormat.format("\tRelationshipType: {0}", customPart.getRelationshipType()));
if (customPart.isExternal()) {
System.out.println("\tSourced from outside the document");
} else {
System.out.println(MessageFormat.format("\tSourced from within the document, length: {0} bytes", customPart.getData().length));
}
index++;
}
// We can remove elements from this collection individually, or all at once.
doc.getPackageCustomParts().removeAt(2);
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
doc.getPackageCustomParts().clear();
Assert.assertEquals(0, doc.getPackageCustomParts().getCount());
| Modifier and Type | Method and Description |
|---|---|
void |
add(CustomPart part)
Adds an item to the collection.
|
void |
clear()
Removes all elements from the collection.
|
CustomPartCollection |
deepClone()
Makes a deep copy of this collection and its items.
|
CustomPart |
get(int index)
Gets an item at the specified index.
|
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,
CustomPart value)
Sets an item at the specified index.
|
public int getCount()
Examples:
Shows how to access a document's arbitrary custom parts collection.
Document doc = new Document(getMyDir() + "Custom parts OOXML package.docx");
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
// Clone the second part, then add the clone to the collection.
CustomPart clonedPart = doc.getPackageCustomParts().get(1).deepClone();
doc.getPackageCustomParts().add(clonedPart);
Assert.assertEquals(3, doc.getPackageCustomParts().getCount());
// Enumerate over the collection and print every part.
Iterator<CustomPart> enumerator = doc.getPackageCustomParts().iterator();
int index = 0;
while (enumerator.hasNext()) {
CustomPart customPart = enumerator.next();
System.out.println(MessageFormat.format("Part index {0}:", index));
System.out.println(MessageFormat.format("\tName: {0}", customPart.getName()));
System.out.println(MessageFormat.format("\tContentType: {0}", customPart.getContentType()));
System.out.println(MessageFormat.format("\tRelationshipType: {0}", customPart.getRelationshipType()));
if (customPart.isExternal()) {
System.out.println("\tSourced from outside the document");
} else {
System.out.println(MessageFormat.format("\tSourced from within the document, length: {0} bytes", customPart.getData().length));
}
index++;
}
// We can remove elements from this collection individually, or all at once.
doc.getPackageCustomParts().removeAt(2);
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
doc.getPackageCustomParts().clear();
Assert.assertEquals(0, doc.getPackageCustomParts().getCount());
public CustomPart get(int index)
Examples:
Shows how to access a document's arbitrary custom parts collection.
Document doc = new Document(getMyDir() + "Custom parts OOXML package.docx");
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
// Clone the second part, then add the clone to the collection.
CustomPart clonedPart = doc.getPackageCustomParts().get(1).deepClone();
doc.getPackageCustomParts().add(clonedPart);
Assert.assertEquals(3, doc.getPackageCustomParts().getCount());
// Enumerate over the collection and print every part.
Iterator<CustomPart> enumerator = doc.getPackageCustomParts().iterator();
int index = 0;
while (enumerator.hasNext()) {
CustomPart customPart = enumerator.next();
System.out.println(MessageFormat.format("Part index {0}:", index));
System.out.println(MessageFormat.format("\tName: {0}", customPart.getName()));
System.out.println(MessageFormat.format("\tContentType: {0}", customPart.getContentType()));
System.out.println(MessageFormat.format("\tRelationshipType: {0}", customPart.getRelationshipType()));
if (customPart.isExternal()) {
System.out.println("\tSourced from outside the document");
} else {
System.out.println(MessageFormat.format("\tSourced from within the document, length: {0} bytes", customPart.getData().length));
}
index++;
}
// We can remove elements from this collection individually, or all at once.
doc.getPackageCustomParts().removeAt(2);
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
doc.getPackageCustomParts().clear();
Assert.assertEquals(0, doc.getPackageCustomParts().getCount());
index - Zero-based index of the item.public void set(int index,
CustomPart value)
Examples:
Shows how to access a document's arbitrary custom parts collection.
Document doc = new Document(getMyDir() + "Custom parts OOXML package.docx");
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
// Clone the second part, then add the clone to the collection.
CustomPart clonedPart = doc.getPackageCustomParts().get(1).deepClone();
doc.getPackageCustomParts().add(clonedPart);
Assert.assertEquals(3, doc.getPackageCustomParts().getCount());
// Enumerate over the collection and print every part.
Iterator<CustomPart> enumerator = doc.getPackageCustomParts().iterator();
int index = 0;
while (enumerator.hasNext()) {
CustomPart customPart = enumerator.next();
System.out.println(MessageFormat.format("Part index {0}:", index));
System.out.println(MessageFormat.format("\tName: {0}", customPart.getName()));
System.out.println(MessageFormat.format("\tContentType: {0}", customPart.getContentType()));
System.out.println(MessageFormat.format("\tRelationshipType: {0}", customPart.getRelationshipType()));
if (customPart.isExternal()) {
System.out.println("\tSourced from outside the document");
} else {
System.out.println(MessageFormat.format("\tSourced from within the document, length: {0} bytes", customPart.getData().length));
}
index++;
}
// We can remove elements from this collection individually, or all at once.
doc.getPackageCustomParts().removeAt(2);
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
doc.getPackageCustomParts().clear();
Assert.assertEquals(0, doc.getPackageCustomParts().getCount());
index - Zero-based index of the item.value - An item at the specified index.public java.util.Iterator iterator()
Examples:
Shows how to access a document's arbitrary custom parts collection.
Document doc = new Document(getMyDir() + "Custom parts OOXML package.docx");
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
// Clone the second part, then add the clone to the collection.
CustomPart clonedPart = doc.getPackageCustomParts().get(1).deepClone();
doc.getPackageCustomParts().add(clonedPart);
Assert.assertEquals(3, doc.getPackageCustomParts().getCount());
// Enumerate over the collection and print every part.
Iterator<CustomPart> enumerator = doc.getPackageCustomParts().iterator();
int index = 0;
while (enumerator.hasNext()) {
CustomPart customPart = enumerator.next();
System.out.println(MessageFormat.format("Part index {0}:", index));
System.out.println(MessageFormat.format("\tName: {0}", customPart.getName()));
System.out.println(MessageFormat.format("\tContentType: {0}", customPart.getContentType()));
System.out.println(MessageFormat.format("\tRelationshipType: {0}", customPart.getRelationshipType()));
if (customPart.isExternal()) {
System.out.println("\tSourced from outside the document");
} else {
System.out.println(MessageFormat.format("\tSourced from within the document, length: {0} bytes", customPart.getData().length));
}
index++;
}
// We can remove elements from this collection individually, or all at once.
doc.getPackageCustomParts().removeAt(2);
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
doc.getPackageCustomParts().clear();
Assert.assertEquals(0, doc.getPackageCustomParts().getCount());
iterator in interface java.lang.Iterablepublic void add(CustomPart part)
Examples:
Shows how to access a document's arbitrary custom parts collection.
Document doc = new Document(getMyDir() + "Custom parts OOXML package.docx");
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
// Clone the second part, then add the clone to the collection.
CustomPart clonedPart = doc.getPackageCustomParts().get(1).deepClone();
doc.getPackageCustomParts().add(clonedPart);
Assert.assertEquals(3, doc.getPackageCustomParts().getCount());
// Enumerate over the collection and print every part.
Iterator<CustomPart> enumerator = doc.getPackageCustomParts().iterator();
int index = 0;
while (enumerator.hasNext()) {
CustomPart customPart = enumerator.next();
System.out.println(MessageFormat.format("Part index {0}:", index));
System.out.println(MessageFormat.format("\tName: {0}", customPart.getName()));
System.out.println(MessageFormat.format("\tContentType: {0}", customPart.getContentType()));
System.out.println(MessageFormat.format("\tRelationshipType: {0}", customPart.getRelationshipType()));
if (customPart.isExternal()) {
System.out.println("\tSourced from outside the document");
} else {
System.out.println(MessageFormat.format("\tSourced from within the document, length: {0} bytes", customPart.getData().length));
}
index++;
}
// We can remove elements from this collection individually, or all at once.
doc.getPackageCustomParts().removeAt(2);
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
doc.getPackageCustomParts().clear();
Assert.assertEquals(0, doc.getPackageCustomParts().getCount());
part - The item to add.public void removeAt(int index)
Examples:
Shows how to access a document's arbitrary custom parts collection.
Document doc = new Document(getMyDir() + "Custom parts OOXML package.docx");
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
// Clone the second part, then add the clone to the collection.
CustomPart clonedPart = doc.getPackageCustomParts().get(1).deepClone();
doc.getPackageCustomParts().add(clonedPart);
Assert.assertEquals(3, doc.getPackageCustomParts().getCount());
// Enumerate over the collection and print every part.
Iterator<CustomPart> enumerator = doc.getPackageCustomParts().iterator();
int index = 0;
while (enumerator.hasNext()) {
CustomPart customPart = enumerator.next();
System.out.println(MessageFormat.format("Part index {0}:", index));
System.out.println(MessageFormat.format("\tName: {0}", customPart.getName()));
System.out.println(MessageFormat.format("\tContentType: {0}", customPart.getContentType()));
System.out.println(MessageFormat.format("\tRelationshipType: {0}", customPart.getRelationshipType()));
if (customPart.isExternal()) {
System.out.println("\tSourced from outside the document");
} else {
System.out.println(MessageFormat.format("\tSourced from within the document, length: {0} bytes", customPart.getData().length));
}
index++;
}
// We can remove elements from this collection individually, or all at once.
doc.getPackageCustomParts().removeAt(2);
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
doc.getPackageCustomParts().clear();
Assert.assertEquals(0, doc.getPackageCustomParts().getCount());
index - The zero based index.public void clear()
Examples:
Shows how to access a document's arbitrary custom parts collection.
Document doc = new Document(getMyDir() + "Custom parts OOXML package.docx");
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
// Clone the second part, then add the clone to the collection.
CustomPart clonedPart = doc.getPackageCustomParts().get(1).deepClone();
doc.getPackageCustomParts().add(clonedPart);
Assert.assertEquals(3, doc.getPackageCustomParts().getCount());
// Enumerate over the collection and print every part.
Iterator<CustomPart> enumerator = doc.getPackageCustomParts().iterator();
int index = 0;
while (enumerator.hasNext()) {
CustomPart customPart = enumerator.next();
System.out.println(MessageFormat.format("Part index {0}:", index));
System.out.println(MessageFormat.format("\tName: {0}", customPart.getName()));
System.out.println(MessageFormat.format("\tContentType: {0}", customPart.getContentType()));
System.out.println(MessageFormat.format("\tRelationshipType: {0}", customPart.getRelationshipType()));
if (customPart.isExternal()) {
System.out.println("\tSourced from outside the document");
} else {
System.out.println(MessageFormat.format("\tSourced from within the document, length: {0} bytes", customPart.getData().length));
}
index++;
}
// We can remove elements from this collection individually, or all at once.
doc.getPackageCustomParts().removeAt(2);
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
doc.getPackageCustomParts().clear();
Assert.assertEquals(0, doc.getPackageCustomParts().getCount());
public CustomPartCollection deepClone()
Examples:
Shows how to access a document's arbitrary custom parts collection.
Document doc = new Document(getMyDir() + "Custom parts OOXML package.docx");
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
// Clone the second part, then add the clone to the collection.
CustomPart clonedPart = doc.getPackageCustomParts().get(1).deepClone();
doc.getPackageCustomParts().add(clonedPart);
Assert.assertEquals(3, doc.getPackageCustomParts().getCount());
// Enumerate over the collection and print every part.
Iterator<CustomPart> enumerator = doc.getPackageCustomParts().iterator();
int index = 0;
while (enumerator.hasNext()) {
CustomPart customPart = enumerator.next();
System.out.println(MessageFormat.format("Part index {0}:", index));
System.out.println(MessageFormat.format("\tName: {0}", customPart.getName()));
System.out.println(MessageFormat.format("\tContentType: {0}", customPart.getContentType()));
System.out.println(MessageFormat.format("\tRelationshipType: {0}", customPart.getRelationshipType()));
if (customPart.isExternal()) {
System.out.println("\tSourced from outside the document");
} else {
System.out.println(MessageFormat.format("\tSourced from within the document, length: {0} bytes", customPart.getData().length));
}
index++;
}
// We can remove elements from this collection individually, or all at once.
doc.getPackageCustomParts().removeAt(2);
Assert.assertEquals(2, doc.getPackageCustomParts().getCount());
doc.getPackageCustomParts().clear();
Assert.assertEquals(0, doc.getPackageCustomParts().getCount());