Aspose::Words::Markup::CustomPart class

CustomPart class

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.

class CustomPart : public System::Object

Methods

MethodDescription
Clone()Makes a “deep enough” copy of the object. Does not duplicate the bytes of the Data value.
CustomPart()
get_ContentType() constSpecifies the content type of this custom part.
get_Data() constContains the data of this custom part.
get_IsExternal() constFalse if this custom part is stored inside the OOXML package. True if this custom part is an external target.
get_Name() constGets or sets this part’s absolute name within the OOXML package or the target URL.
get_RelationshipType() constGets or sets the relationship type from the parent part to this custom part.
GetType() const override
Is(const System::TypeInfo&) const override
set_ContentType(const System::String&)Setter for Aspose::Words::Markup::CustomPart::get_ContentType.
set_Data(const System::ArrayPtr<uint8_t>&)Setter for Aspose::Words::Markup::CustomPart::get_Data.
set_IsExternal(bool)Setter for Aspose::Words::Markup::CustomPart::get_IsExternal.
set_Name(const System::String&)Setter for Aspose::Words::Markup::CustomPart::get_Name.
set_RelationshipType(const System::String&)Setter for Aspose::Words::Markup::CustomPart::get_RelationshipType.
static Type()

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.

auto doc = MakeObject<Document>(MyDir + u"Custom parts OOXML package.docx");

ASSERT_EQ(2, doc->get_PackageCustomParts()->get_Count());

// Clone the second part, then add the clone to the collection.
SharedPtr<CustomPart> clonedPart = doc->get_PackageCustomParts()->idx_get(1)->Clone();
doc->get_PackageCustomParts()->Add(clonedPart);

ASSERT_EQ(3, doc->get_PackageCustomParts()->get_Count());

// Enumerate over the collection and print every part.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<CustomPart>>> enumerator = doc->get_PackageCustomParts()->GetEnumerator();
    int index = 0;
    while (enumerator->MoveNext())
    {
        std::cout << "Part index " << index << ":" << std::endl;
        std::cout << "\tName:\t\t\t\t" << enumerator->get_Current()->get_Name() << std::endl;
        std::cout << "\tContent type:\t\t" << enumerator->get_Current()->get_ContentType() << std::endl;
        std::cout << "\tRelationship type:\t" << enumerator->get_Current()->get_RelationshipType() << std::endl;
        std::cout << (enumerator->get_Current()->get_IsExternal()
                          ? u"\tSourced from outside the document"
                          : String::Format(u"\tStored within the document, length: {0} bytes", enumerator->get_Current()->get_Data()->get_Length()))
                  << std::endl;
        index++;
    }
}

// We can remove elements from this collection individually, or all at once.
doc->get_PackageCustomParts()->RemoveAt(2);

ASSERT_EQ(2, doc->get_PackageCustomParts()->get_Count());

doc->get_PackageCustomParts()->Clear();

ASSERT_EQ(0, doc->get_PackageCustomParts()->get_Count());

See Also

Aspose::Words::Markup::CustomPartCollection class