CustomPart
Inheritance: java.lang.Object
All Implemented Interfaces: java.lang.Cloneable
public class CustomPart implements Cloneable
Represents a custom (arbitrary content) part, that is not defined by the ISO/IEC 29500 standard.
To learn more, visit the Structured Document Tags or Content Control documentation article.
Remarks:
This class represents an OOXML part that is a target of an “unknown relationship”. All relationships not defined within ISO/IEC 29500 are considered “unknown relationships”. Unknown relationships are permitted within an Office Open XML document provided that they conform to relationship markup guidelines.
Microsoft Word preserves custom parts during open/save cycles. Some additional info can be found here http://blogs.msdn.com/dmahugh/archive/2006/11/25/arbitrary-content-in-an-opc-package.aspx
Aspose.Words also roundtrips custom parts and in addition, allows to programmatically access such parts via the CustomPart and CustomPartCollection objects.
Do not confuse custom parts with Custom XML Data. Use CustomXmlPart if you need to access Custom XML Data.
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 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());
Methods
| Method | Description |
|---|---|
| deepClone() | Makes a “deep enough” copy of the object. |
| getContentType() | Specifies the content type of this custom part. |
| getData() | Contains the data of this custom part. |
| getName() | Gets this part’s absolute name within the OOXML package or the target URL. |
| getRelationshipType() | Gets the relationship type from the parent part to this custom part. |
| isExternal() | False if this custom part is stored inside the OOXML package. |
| isExternal(boolean value) | False if this custom part is stored inside the OOXML package. |
| setContentType(String value) | Specifies the content type of this custom part. |
| setData(byte[] value) | Contains the data of this custom part. |
| setName(String value) | Sets this part’s absolute name within the OOXML package or the target URL. |
| setRelationshipType(String value) | Sets the relationship type from the parent part to this custom part. |
deepClone()
public CustomPart deepClone()
Makes a “deep enough” copy of the object. Does not duplicate the bytes of the getData() / setData(byte[]) 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 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());
Returns: CustomPart
getContentType()
public String getContentType()
Specifies the content type of this custom part.
Remarks:
This property is applicable only when isExternal() / isExternal(boolean) is false .
The default value is an empty string. A valid value must be a non-empty string.
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 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());
Returns: java.lang.String - The corresponding java.lang.String value.
getData()
public byte[] getData()
Contains the data of this custom part.
Remarks:
This property is applicable only when isExternal() / isExternal(boolean) is false .
The default value is an empty byte array. The value cannot be null .
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 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());
Returns: byte[] - The corresponding byte[] value.
getName()
public String getName()
Gets this part’s absolute name within the OOXML package or the target URL.
Remarks:
If the relationship target is internal, then this property is the absolute part name within the package. If the relationship target is external, then this property is the target URL.
The default value is an empty string. A valid value must be a non-empty string.
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 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());
Returns: java.lang.String - This part’s absolute name within the OOXML package or the target URL.
getRelationshipType()
public String getRelationshipType()
Gets the relationship type from the parent part to this custom part.
Remarks:
The relationship type for a custom part must be “unknown” e.g. a custom relationship type, not one of the relationship types defined within ISO/IEC 29500.
The default value is an empty string. A valid value must be a non-empty string.
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 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());
Returns: java.lang.String - The relationship type from the parent part to this custom part.
isExternal()
public boolean isExternal()
False if this custom part is stored inside the OOXML package. True if this custom part is an external target.
Remarks:
The default value is false .
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 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());
Returns: boolean - The corresponding boolean value.
isExternal(boolean value)
public void isExternal(boolean value)
False if this custom part is stored inside the OOXML package. True if this custom part is an external target.
Remarks:
The default value is false .
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 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());
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setContentType(String value)
public void setContentType(String value)
Specifies the content type of this custom part.
Remarks:
This property is applicable only when isExternal() / isExternal(boolean) is false .
The default value is an empty string. A valid value must be a non-empty string.
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 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());
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The corresponding java.lang.String value. |
setData(byte[] value)
public void setData(byte[] value)
Contains the data of this custom part.
Remarks:
This property is applicable only when isExternal() / isExternal(boolean) is false .
The default value is an empty byte array. The value cannot be null .
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 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());
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte[] | The corresponding byte[] value. |
setName(String value)
public void setName(String value)
Sets this part’s absolute name within the OOXML package or the target URL.
Remarks:
If the relationship target is internal, then this property is the absolute part name within the package. If the relationship target is external, then this property is the target URL.
The default value is an empty string. A valid value must be a non-empty string.
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 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());
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | This part’s absolute name within the OOXML package or the target URL. |
setRelationshipType(String value)
public void setRelationshipType(String value)
Sets the relationship type from the parent part to this custom part.
Remarks:
The relationship type for a custom part must be “unknown” e.g. a custom relationship type, not one of the relationship types defined within ISO/IEC 29500.
The default value is an empty string. A valid value must be a non-empty string.
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 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());
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The relationship type from the parent part to this custom part. |
