Aspose::Words::Markup::CustomPart Class Reference

Detailed Description

Represents a custom (arbitrary content) part, that is not defined by the ISO/IEC 29500 standard.

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.

See also

Aspose::Words::Markup::CustomPartCollection

Aspose::Words::Document::get_PackageCustomParts

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());

#include <Aspose.Words.Cpp/Markup/CustomPart.h>

Inheritance diagram for Aspose::Words::Markup::CustomPart:

Public Member Functions
	CustomPart ()
SharedPtr< CustomPart >	Clone ()
	Makes a "deep enough" copy of the object. Does not duplicate the bytes of the Data value. More...
String	get_ContentType () const
	Specifies the content type of this custom part. More...
ArrayPtr< uint8_t >	get_Data () const
	Contains the data of this custom part. More...
bool	get_IsExternal () const
	False if this custom part is stored inside the OOXML package. True if this custom part is an external target. More...
String	get_Name () const
	Gets or sets this part's absolute name within the OOXML package or the target URL. More...
String	get_RelationshipType () const
	Gets or sets the relationship type from the parent part to this custom part. More...
virtual const TypeInfo &	GetType () const override
virtual bool	Is (const TypeInfo &target) const override
void	set_ContentType (const String &value)
	Setter for get_ContentType. More...
void	set_Data (const ArrayPtr< uint8_t > &value)
	Setter for get_Data. More...
void	set_IsExternal (bool value)
	Setter for get_IsExternal. More...
void	set_Name (const String &value)
	Setter for get_Name. More...
void	set_RelationshipType (const String &value)
	Setter for get_RelationshipType. More...

Static Public Member Functions
static const TypeInfo &	Type ()

Constructor & Destructor Documentation

CustomPart()

Aspose::Words::Markup::CustomPart::CustomPart

(

)

Member Function Documentation

Clone()

System::SharedPtr<Aspose::Words::Markup::CustomPart> Aspose::Words::Markup::CustomPart::Clone

(

)

Makes a "deep enough" copy of the object. Does not duplicate the bytes of the Data value.

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());

get_ContentType()

System::String Aspose::Words::Markup::CustomPart::get_ContentType

(

)

const

Specifies the content type of this custom part.

This property is applicable only when IsExternal 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.

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());

get_Data()

System::ArrayPtr<uint8_t> Aspose::Words::Markup::CustomPart::get_Data

(

)

const

Contains the data of this custom part.

This property is applicable only when IsExternal 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.

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());

get_IsExternal()

bool Aspose::Words::Markup::CustomPart::get_IsExternal

(

)

const

False if this custom part is stored inside the OOXML package. True if this custom part is an external target.

The default value is false.

See also

Aspose::Words::Markup::CustomPart::get_Name

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());

get_Name()

System::String Aspose::Words::Markup::CustomPart::get_Name

(

)

const

Gets or sets this part's absolute name within the OOXML package or the target URL.

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.

See also

Aspose::Words::Markup::CustomPart::get_IsExternal

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());

get_RelationshipType()

System::String Aspose::Words::Markup::CustomPart::get_RelationshipType

(

)

const

Gets or sets the relationship type from the parent part to this custom part.

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.

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());

GetType()

virtual const System::TypeInfo& Aspose::Words::Markup::CustomPart::GetType ( ) const

overridevirtual

Reimplemented from System::Object.

Is()

virtual bool Aspose::Words::Markup::CustomPart::Is ( const System::TypeInfo &  target ) const

overridevirtual

Reimplemented from System::Object.

set_ContentType()

void Aspose::Words::Markup::CustomPart::set_ContentType

(

const System::String &

value

)

Setter for Aspose::Words::Markup::CustomPart::get_ContentType.

set_Data()

void Aspose::Words::Markup::CustomPart::set_Data

(

const System::ArrayPtr< uint8_t > &

value

)

Setter for Aspose::Words::Markup::CustomPart::get_Data.

set_IsExternal()

void Aspose::Words::Markup::CustomPart::set_IsExternal

(

bool

value

)

Setter for Aspose::Words::Markup::CustomPart::get_IsExternal.

set_Name()

void Aspose::Words::Markup::CustomPart::set_Name

(

const System::String &

value

)

Setter for Aspose::Words::Markup::CustomPart::get_Name.

set_RelationshipType()

void Aspose::Words::Markup::CustomPart::set_RelationshipType

(

const System::String &

value

)

Setter for Aspose::Words::Markup::CustomPart::get_RelationshipType.

Type()

static const System::TypeInfo& Aspose::Words::Markup::CustomPart::Type ( )

static