Detailed Description

Represents a collection of Custom XML Parts. The items are CustomXmlPart objects.

You do not normally need to create instances of this class. You can access custom XML data stored in a document via the CustomXmlParts property.

See also: Aspose::Words::Markup::CustomXmlPart; Aspose::Words::Document::get_CustomXmlParts

Examples

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

auto doc = MakeObject<Document>();
 
// Construct an XML part that contains data and add it to the document's collection.
// If we enable the "Developer" tab in Microsoft Word,
// we can find elements from this collection in the "XML Mapping Pane", along with a few default elements.
String xmlPartId = System::Guid::NewGuid().ToString(u"B");
String xmlPartContent = u"<root><text>Hello world!</text></root>";
SharedPtr<CustomXmlPart> xmlPart = doc->get_CustomXmlParts()->Add(xmlPartId, xmlPartContent);
 
ASPOSE_ASSERT_EQ(System::Text::Encoding::get_ASCII()->GetBytes(xmlPartContent), xmlPart->get_Data());
ASSERT_EQ(xmlPartId, xmlPart->get_Id());
 
// Below are two ways to refer to XML parts.
// 1 -  By an index in the custom XML part collection:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->idx_get(0));
 
// 2 -  By GUID:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->GetById(xmlPartId));
 
// Add an XML schema association.
xmlPart->get_Schemas()->Add(u"http://www.w3.org/2001/XMLSchema");
 
// Clone a part, and then insert it into the collection.
SharedPtr<CustomXmlPart> xmlPartClone = xmlPart->Clone();
xmlPartClone->set_Id(System::Guid::NewGuid().ToString(u"B"));
doc->get_CustomXmlParts()->Add(xmlPartClone);
 
ASSERT_EQ(2, doc->get_CustomXmlParts()->get_Count());
 
// Iterate through the collection and print the contents of each part.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<CustomXmlPart>>> enumerator = doc->get_CustomXmlParts()->GetEnumerator();
    int index = 0;
    while (enumerator->MoveNext())
    {
        std::cout << "XML part index " << index << ", ID: " << enumerator->get_Current()->get_Id() << std::endl;
        std::cout << "\tContent: " << System::Text::Encoding::get_UTF8()->GetString(enumerator->get_Current()->get_Data()) << std::endl;
        index++;
    }
}
 
// Use the "RemoveAt" method to remove the cloned part by index.
doc->get_CustomXmlParts()->RemoveAt(1);
 
ASSERT_EQ(1, doc->get_CustomXmlParts()->get_Count());
 
// Clone the XML parts collection, and then use the "Clear" method to remove all its elements at once.
SharedPtr<CustomXmlPartCollection> customXmlParts = doc->get_CustomXmlParts()->Clone();
customXmlParts->Clear();
 
// Create a structured document tag that will display our part's contents and insert it into the document body.
auto tag = MakeObject<StructuredDocumentTag>(doc, SdtType::PlainText, MarkupLevel::Block);
tag->get_XmlMapping()->SetMapping(xmlPart, u"/root[1]/text[1]", String::Empty);
 
doc->get_FirstSection()->get_Body()->AppendChild(tag);
 
doc->Save(ArtifactsDir + u"StructuredDocumentTag.CustomXml.docx");

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

Inheritance diagram for Aspose::Words::Markup::CustomXmlPartCollection:

Public Types
using	const_iterator = typename const_iterator

using	iterator = typename iterator

using	iterator_holder_type = List< SharedPtr< CustomXmlPart > >

using	virtualized_iterator = typename virtualized_iterator

using	virtualized_iterator_element = typename virtualized_iterator_element

Public Member Functions
	CustomXmlPartCollection ()

void	Add (const SharedPtr< CustomXmlPart > &part)
	Adds an item to the collection. More...

SharedPtr< CustomXmlPart >	Add (const String &id, const String &xml)
	Creates a new XML part with the specified XML and adds it to the collection. More...

const_iterator	begin () const noexcept

iterator	begin () noexcept

const_iterator	cbegin () const noexcept

const_iterator	cend () const noexcept

void	Clear ()
	Removes all elements from the collection. More...

SharedPtr< CustomXmlPartCollection >	Clone ()
	Makes a deep copy of this collection and its items. More...

const_iterator	end () const noexcept

iterator	end () noexcept

int32_t	get_Count ()
	Gets the number of elements contained in the collection. More...

SharedPtr< CustomXmlPart >	GetById (const String &id)
	Finds and returns a custom XML part by its identifier. More...

SharedPtr< IEnumerator< SharedPtr< CustomXmlPart > > >	GetEnumerator () override
	Returns an enumerator object that can be used to iterate over all items in the collection. More...

virtual const TypeInfo &	GetType () const override

SharedPtr< CustomXmlPart >	idx_get (int32_t index)
	Gets or sets an item at the specified index. More...

void	idx_set (int32_t index, const SharedPtr< CustomXmlPart > &value)
	Gets or sets an item at the specified index. More...

virtual bool	Is (const TypeInfo &target) const override

void	RemoveAt (int32_t index)
	Removes an item at the specified index. More...

virtualized_iterator *	virtualizeBeginConstIterator () const override

virtualized_iterator *	virtualizeBeginIterator () override

virtualized_iterator *	virtualizeEndConstIterator () const override

virtualized_iterator *	virtualizeEndIterator () override

Static Public Member Functions
static const TypeInfo &	Type ()

Member Typedef Documentation

◆ const_iterator

using Aspose::Words::Markup::CustomXmlPartCollection::const_iterator = typename iterator_holder_type::const_iterator

◆ iterator

using Aspose::Words::Markup::CustomXmlPartCollection::iterator = typename iterator_holder_type::iterator

◆ iterator_holder_type

using Aspose::Words::Markup::CustomXmlPartCollection::iterator_holder_type = System::Collections::Generic::List<System::SharedPtr<Aspose::Words::Markup::CustomXmlPart> >

◆ virtualized_iterator

using Aspose::Words::Markup::CustomXmlPartCollection::virtualized_iterator = typename iterator_holder_type::virtualized_iterator

◆ virtualized_iterator_element

using Aspose::Words::Markup::CustomXmlPartCollection::virtualized_iterator_element = typename iterator_holder_type::virtualized_iterator_element

Constructor & Destructor Documentation

◆ CustomXmlPartCollection()

Aspose::Words::Markup::CustomXmlPartCollection::CustomXmlPartCollection ( )

Member Function Documentation

◆ Add() [1/2]

void Aspose::Words::Markup::CustomXmlPartCollection::Add ( const System::SharedPtr< Aspose::Words::Markup::CustomXmlPart > & part )

Adds an item to the collection.

Parameters

part	The custom XML part to add.

Examples

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

auto doc = MakeObject<Document>();
 
// Construct an XML part that contains data and add it to the document's collection.
// If we enable the "Developer" tab in Microsoft Word,
// we can find elements from this collection in the "XML Mapping Pane", along with a few default elements.
String xmlPartId = System::Guid::NewGuid().ToString(u"B");
String xmlPartContent = u"<root><text>Hello world!</text></root>";
SharedPtr<CustomXmlPart> xmlPart = doc->get_CustomXmlParts()->Add(xmlPartId, xmlPartContent);
 
ASPOSE_ASSERT_EQ(System::Text::Encoding::get_ASCII()->GetBytes(xmlPartContent), xmlPart->get_Data());
ASSERT_EQ(xmlPartId, xmlPart->get_Id());
 
// Below are two ways to refer to XML parts.
// 1 -  By an index in the custom XML part collection:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->idx_get(0));
 
// 2 -  By GUID:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->GetById(xmlPartId));
 
// Add an XML schema association.
xmlPart->get_Schemas()->Add(u"http://www.w3.org/2001/XMLSchema");
 
// Clone a part, and then insert it into the collection.
SharedPtr<CustomXmlPart> xmlPartClone = xmlPart->Clone();
xmlPartClone->set_Id(System::Guid::NewGuid().ToString(u"B"));
doc->get_CustomXmlParts()->Add(xmlPartClone);
 
ASSERT_EQ(2, doc->get_CustomXmlParts()->get_Count());
 
// Iterate through the collection and print the contents of each part.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<CustomXmlPart>>> enumerator = doc->get_CustomXmlParts()->GetEnumerator();
    int index = 0;
    while (enumerator->MoveNext())
    {
        std::cout << "XML part index " << index << ", ID: " << enumerator->get_Current()->get_Id() << std::endl;
        std::cout << "\tContent: " << System::Text::Encoding::get_UTF8()->GetString(enumerator->get_Current()->get_Data()) << std::endl;
        index++;
    }
}
 
// Use the "RemoveAt" method to remove the cloned part by index.
doc->get_CustomXmlParts()->RemoveAt(1);
 
ASSERT_EQ(1, doc->get_CustomXmlParts()->get_Count());
 
// Clone the XML parts collection, and then use the "Clear" method to remove all its elements at once.
SharedPtr<CustomXmlPartCollection> customXmlParts = doc->get_CustomXmlParts()->Clone();
customXmlParts->Clear();
 
// Create a structured document tag that will display our part's contents and insert it into the document body.
auto tag = MakeObject<StructuredDocumentTag>(doc, SdtType::PlainText, MarkupLevel::Block);
tag->get_XmlMapping()->SetMapping(xmlPart, u"/root[1]/text[1]", String::Empty);
 
doc->get_FirstSection()->get_Body()->AppendChild(tag);
 
doc->Save(ArtifactsDir + u"StructuredDocumentTag.CustomXml.docx");

◆ Add() [2/2]

System::SharedPtr<Aspose::Words::Markup::CustomXmlPart> Aspose::Words::Markup::CustomXmlPartCollection::Add	(	const System::String &	id,
		const System::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.

Examples

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

auto doc = MakeObject<Document>();
 
// Construct an XML part that contains data and add it to the document's collection.
// If we enable the "Developer" tab in Microsoft Word,
// we can find elements from this collection in the "XML Mapping Pane", along with a few default elements.
String xmlPartId = System::Guid::NewGuid().ToString(u"B");
String xmlPartContent = u"<root><text>Hello world!</text></root>";
SharedPtr<CustomXmlPart> xmlPart = doc->get_CustomXmlParts()->Add(xmlPartId, xmlPartContent);
 
ASPOSE_ASSERT_EQ(System::Text::Encoding::get_ASCII()->GetBytes(xmlPartContent), xmlPart->get_Data());
ASSERT_EQ(xmlPartId, xmlPart->get_Id());
 
// Below are two ways to refer to XML parts.
// 1 -  By an index in the custom XML part collection:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->idx_get(0));
 
// 2 -  By GUID:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->GetById(xmlPartId));
 
// Add an XML schema association.
xmlPart->get_Schemas()->Add(u"http://www.w3.org/2001/XMLSchema");
 
// Clone a part, and then insert it into the collection.
SharedPtr<CustomXmlPart> xmlPartClone = xmlPart->Clone();
xmlPartClone->set_Id(System::Guid::NewGuid().ToString(u"B"));
doc->get_CustomXmlParts()->Add(xmlPartClone);
 
ASSERT_EQ(2, doc->get_CustomXmlParts()->get_Count());
 
// Iterate through the collection and print the contents of each part.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<CustomXmlPart>>> enumerator = doc->get_CustomXmlParts()->GetEnumerator();
    int index = 0;
    while (enumerator->MoveNext())
    {
        std::cout << "XML part index " << index << ", ID: " << enumerator->get_Current()->get_Id() << std::endl;
        std::cout << "\tContent: " << System::Text::Encoding::get_UTF8()->GetString(enumerator->get_Current()->get_Data()) << std::endl;
        index++;
    }
}
 
// Use the "RemoveAt" method to remove the cloned part by index.
doc->get_CustomXmlParts()->RemoveAt(1);
 
ASSERT_EQ(1, doc->get_CustomXmlParts()->get_Count());
 
// Clone the XML parts collection, and then use the "Clear" method to remove all its elements at once.
SharedPtr<CustomXmlPartCollection> customXmlParts = doc->get_CustomXmlParts()->Clone();
customXmlParts->Clear();
 
// Create a structured document tag that will display our part's contents and insert it into the document body.
auto tag = MakeObject<StructuredDocumentTag>(doc, SdtType::PlainText, MarkupLevel::Block);
tag->get_XmlMapping()->SetMapping(xmlPart, u"/root[1]/text[1]", String::Empty);
 
doc->get_FirstSection()->get_Body()->AppendChild(tag);
 
doc->Save(ArtifactsDir + u"StructuredDocumentTag.CustomXml.docx");

◆ begin() [1/2]

const_iterator Aspose::Words::Markup::CustomXmlPartCollection::begin ( ) const

noexcept

◆ begin() [2/2]

iterator Aspose::Words::Markup::CustomXmlPartCollection::begin ( )

noexcept

◆ cbegin()

const_iterator Aspose::Words::Markup::CustomXmlPartCollection::cbegin ( ) const

noexcept

◆ cend()

const_iterator Aspose::Words::Markup::CustomXmlPartCollection::cend ( ) const

noexcept

◆ Clear()

void Aspose::Words::Markup::CustomXmlPartCollection::Clear ( )

Removes all elements from the collection.

Examples

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

auto doc = MakeObject<Document>();
 
// Construct an XML part that contains data and add it to the document's collection.
// If we enable the "Developer" tab in Microsoft Word,
// we can find elements from this collection in the "XML Mapping Pane", along with a few default elements.
String xmlPartId = System::Guid::NewGuid().ToString(u"B");
String xmlPartContent = u"<root><text>Hello world!</text></root>";
SharedPtr<CustomXmlPart> xmlPart = doc->get_CustomXmlParts()->Add(xmlPartId, xmlPartContent);
 
ASPOSE_ASSERT_EQ(System::Text::Encoding::get_ASCII()->GetBytes(xmlPartContent), xmlPart->get_Data());
ASSERT_EQ(xmlPartId, xmlPart->get_Id());
 
// Below are two ways to refer to XML parts.
// 1 -  By an index in the custom XML part collection:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->idx_get(0));
 
// 2 -  By GUID:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->GetById(xmlPartId));
 
// Add an XML schema association.
xmlPart->get_Schemas()->Add(u"http://www.w3.org/2001/XMLSchema");
 
// Clone a part, and then insert it into the collection.
SharedPtr<CustomXmlPart> xmlPartClone = xmlPart->Clone();
xmlPartClone->set_Id(System::Guid::NewGuid().ToString(u"B"));
doc->get_CustomXmlParts()->Add(xmlPartClone);
 
ASSERT_EQ(2, doc->get_CustomXmlParts()->get_Count());
 
// Iterate through the collection and print the contents of each part.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<CustomXmlPart>>> enumerator = doc->get_CustomXmlParts()->GetEnumerator();
    int index = 0;
    while (enumerator->MoveNext())
    {
        std::cout << "XML part index " << index << ", ID: " << enumerator->get_Current()->get_Id() << std::endl;
        std::cout << "\tContent: " << System::Text::Encoding::get_UTF8()->GetString(enumerator->get_Current()->get_Data()) << std::endl;
        index++;
    }
}
 
// Use the "RemoveAt" method to remove the cloned part by index.
doc->get_CustomXmlParts()->RemoveAt(1);
 
ASSERT_EQ(1, doc->get_CustomXmlParts()->get_Count());
 
// Clone the XML parts collection, and then use the "Clear" method to remove all its elements at once.
SharedPtr<CustomXmlPartCollection> customXmlParts = doc->get_CustomXmlParts()->Clone();
customXmlParts->Clear();
 
// Create a structured document tag that will display our part's contents and insert it into the document body.
auto tag = MakeObject<StructuredDocumentTag>(doc, SdtType::PlainText, MarkupLevel::Block);
tag->get_XmlMapping()->SetMapping(xmlPart, u"/root[1]/text[1]", String::Empty);
 
doc->get_FirstSection()->get_Body()->AppendChild(tag);
 
doc->Save(ArtifactsDir + u"StructuredDocumentTag.CustomXml.docx");

◆ Clone()

System::SharedPtr<Aspose::Words::Markup::CustomXmlPartCollection> Aspose::Words::Markup::CustomXmlPartCollection::Clone ( )

Makes a deep copy of this collection and its items.

Examples

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

auto doc = MakeObject<Document>();
 
// Construct an XML part that contains data and add it to the document's collection.
// If we enable the "Developer" tab in Microsoft Word,
// we can find elements from this collection in the "XML Mapping Pane", along with a few default elements.
String xmlPartId = System::Guid::NewGuid().ToString(u"B");
String xmlPartContent = u"<root><text>Hello world!</text></root>";
SharedPtr<CustomXmlPart> xmlPart = doc->get_CustomXmlParts()->Add(xmlPartId, xmlPartContent);
 
ASPOSE_ASSERT_EQ(System::Text::Encoding::get_ASCII()->GetBytes(xmlPartContent), xmlPart->get_Data());
ASSERT_EQ(xmlPartId, xmlPart->get_Id());
 
// Below are two ways to refer to XML parts.
// 1 -  By an index in the custom XML part collection:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->idx_get(0));
 
// 2 -  By GUID:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->GetById(xmlPartId));
 
// Add an XML schema association.
xmlPart->get_Schemas()->Add(u"http://www.w3.org/2001/XMLSchema");
 
// Clone a part, and then insert it into the collection.
SharedPtr<CustomXmlPart> xmlPartClone = xmlPart->Clone();
xmlPartClone->set_Id(System::Guid::NewGuid().ToString(u"B"));
doc->get_CustomXmlParts()->Add(xmlPartClone);
 
ASSERT_EQ(2, doc->get_CustomXmlParts()->get_Count());
 
// Iterate through the collection and print the contents of each part.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<CustomXmlPart>>> enumerator = doc->get_CustomXmlParts()->GetEnumerator();
    int index = 0;
    while (enumerator->MoveNext())
    {
        std::cout << "XML part index " << index << ", ID: " << enumerator->get_Current()->get_Id() << std::endl;
        std::cout << "\tContent: " << System::Text::Encoding::get_UTF8()->GetString(enumerator->get_Current()->get_Data()) << std::endl;
        index++;
    }
}
 
// Use the "RemoveAt" method to remove the cloned part by index.
doc->get_CustomXmlParts()->RemoveAt(1);
 
ASSERT_EQ(1, doc->get_CustomXmlParts()->get_Count());
 
// Clone the XML parts collection, and then use the "Clear" method to remove all its elements at once.
SharedPtr<CustomXmlPartCollection> customXmlParts = doc->get_CustomXmlParts()->Clone();
customXmlParts->Clear();
 
// Create a structured document tag that will display our part's contents and insert it into the document body.
auto tag = MakeObject<StructuredDocumentTag>(doc, SdtType::PlainText, MarkupLevel::Block);
tag->get_XmlMapping()->SetMapping(xmlPart, u"/root[1]/text[1]", String::Empty);
 
doc->get_FirstSection()->get_Body()->AppendChild(tag);
 
doc->Save(ArtifactsDir + u"StructuredDocumentTag.CustomXml.docx");

◆ end() [1/2]

const_iterator Aspose::Words::Markup::CustomXmlPartCollection::end ( ) const

noexcept

◆ end() [2/2]

iterator Aspose::Words::Markup::CustomXmlPartCollection::end ( )

noexcept

◆ get_Count()

int32_t Aspose::Words::Markup::CustomXmlPartCollection::get_Count ( )

Gets the number of elements contained in the collection.

Examples

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

auto doc = MakeObject<Document>();
 
// Construct an XML part that contains data and add it to the document's collection.
// If we enable the "Developer" tab in Microsoft Word,
// we can find elements from this collection in the "XML Mapping Pane", along with a few default elements.
String xmlPartId = System::Guid::NewGuid().ToString(u"B");
String xmlPartContent = u"<root><text>Hello world!</text></root>";
SharedPtr<CustomXmlPart> xmlPart = doc->get_CustomXmlParts()->Add(xmlPartId, xmlPartContent);
 
ASPOSE_ASSERT_EQ(System::Text::Encoding::get_ASCII()->GetBytes(xmlPartContent), xmlPart->get_Data());
ASSERT_EQ(xmlPartId, xmlPart->get_Id());
 
// Below are two ways to refer to XML parts.
// 1 -  By an index in the custom XML part collection:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->idx_get(0));
 
// 2 -  By GUID:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->GetById(xmlPartId));
 
// Add an XML schema association.
xmlPart->get_Schemas()->Add(u"http://www.w3.org/2001/XMLSchema");
 
// Clone a part, and then insert it into the collection.
SharedPtr<CustomXmlPart> xmlPartClone = xmlPart->Clone();
xmlPartClone->set_Id(System::Guid::NewGuid().ToString(u"B"));
doc->get_CustomXmlParts()->Add(xmlPartClone);
 
ASSERT_EQ(2, doc->get_CustomXmlParts()->get_Count());
 
// Iterate through the collection and print the contents of each part.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<CustomXmlPart>>> enumerator = doc->get_CustomXmlParts()->GetEnumerator();
    int index = 0;
    while (enumerator->MoveNext())
    {
        std::cout << "XML part index " << index << ", ID: " << enumerator->get_Current()->get_Id() << std::endl;
        std::cout << "\tContent: " << System::Text::Encoding::get_UTF8()->GetString(enumerator->get_Current()->get_Data()) << std::endl;
        index++;
    }
}
 
// Use the "RemoveAt" method to remove the cloned part by index.
doc->get_CustomXmlParts()->RemoveAt(1);
 
ASSERT_EQ(1, doc->get_CustomXmlParts()->get_Count());
 
// Clone the XML parts collection, and then use the "Clear" method to remove all its elements at once.
SharedPtr<CustomXmlPartCollection> customXmlParts = doc->get_CustomXmlParts()->Clone();
customXmlParts->Clear();
 
// Create a structured document tag that will display our part's contents and insert it into the document body.
auto tag = MakeObject<StructuredDocumentTag>(doc, SdtType::PlainText, MarkupLevel::Block);
tag->get_XmlMapping()->SetMapping(xmlPart, u"/root[1]/text[1]", String::Empty);
 
doc->get_FirstSection()->get_Body()->AppendChild(tag);
 
doc->Save(ArtifactsDir + u"StructuredDocumentTag.CustomXml.docx");

◆ GetById()

System::SharedPtr<Aspose::Words::Markup::CustomXmlPart> Aspose::Words::Markup::CustomXmlPartCollection::GetById ( const System::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.

Examples

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

auto doc = MakeObject<Document>();
 
// Construct an XML part that contains data and add it to the document's collection.
// If we enable the "Developer" tab in Microsoft Word,
// we can find elements from this collection in the "XML Mapping Pane", along with a few default elements.
String xmlPartId = System::Guid::NewGuid().ToString(u"B");
String xmlPartContent = u"<root><text>Hello world!</text></root>";
SharedPtr<CustomXmlPart> xmlPart = doc->get_CustomXmlParts()->Add(xmlPartId, xmlPartContent);
 
ASPOSE_ASSERT_EQ(System::Text::Encoding::get_ASCII()->GetBytes(xmlPartContent), xmlPart->get_Data());
ASSERT_EQ(xmlPartId, xmlPart->get_Id());
 
// Below are two ways to refer to XML parts.
// 1 -  By an index in the custom XML part collection:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->idx_get(0));
 
// 2 -  By GUID:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->GetById(xmlPartId));
 
// Add an XML schema association.
xmlPart->get_Schemas()->Add(u"http://www.w3.org/2001/XMLSchema");
 
// Clone a part, and then insert it into the collection.
SharedPtr<CustomXmlPart> xmlPartClone = xmlPart->Clone();
xmlPartClone->set_Id(System::Guid::NewGuid().ToString(u"B"));
doc->get_CustomXmlParts()->Add(xmlPartClone);
 
ASSERT_EQ(2, doc->get_CustomXmlParts()->get_Count());
 
// Iterate through the collection and print the contents of each part.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<CustomXmlPart>>> enumerator = doc->get_CustomXmlParts()->GetEnumerator();
    int index = 0;
    while (enumerator->MoveNext())
    {
        std::cout << "XML part index " << index << ", ID: " << enumerator->get_Current()->get_Id() << std::endl;
        std::cout << "\tContent: " << System::Text::Encoding::get_UTF8()->GetString(enumerator->get_Current()->get_Data()) << std::endl;
        index++;
    }
}
 
// Use the "RemoveAt" method to remove the cloned part by index.
doc->get_CustomXmlParts()->RemoveAt(1);
 
ASSERT_EQ(1, doc->get_CustomXmlParts()->get_Count());
 
// Clone the XML parts collection, and then use the "Clear" method to remove all its elements at once.
SharedPtr<CustomXmlPartCollection> customXmlParts = doc->get_CustomXmlParts()->Clone();
customXmlParts->Clear();
 
// Create a structured document tag that will display our part's contents and insert it into the document body.
auto tag = MakeObject<StructuredDocumentTag>(doc, SdtType::PlainText, MarkupLevel::Block);
tag->get_XmlMapping()->SetMapping(xmlPart, u"/root[1]/text[1]", String::Empty);
 
doc->get_FirstSection()->get_Body()->AppendChild(tag);
 
doc->Save(ArtifactsDir + u"StructuredDocumentTag.CustomXml.docx");

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Aspose::Words::Markup::CustomXmlPart> > > Aspose::Words::Markup::CustomXmlPartCollection::GetEnumerator ( )

override

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

Examples

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

auto doc = MakeObject<Document>();
 
// Construct an XML part that contains data and add it to the document's collection.
// If we enable the "Developer" tab in Microsoft Word,
// we can find elements from this collection in the "XML Mapping Pane", along with a few default elements.
String xmlPartId = System::Guid::NewGuid().ToString(u"B");
String xmlPartContent = u"<root><text>Hello world!</text></root>";
SharedPtr<CustomXmlPart> xmlPart = doc->get_CustomXmlParts()->Add(xmlPartId, xmlPartContent);
 
ASPOSE_ASSERT_EQ(System::Text::Encoding::get_ASCII()->GetBytes(xmlPartContent), xmlPart->get_Data());
ASSERT_EQ(xmlPartId, xmlPart->get_Id());
 
// Below are two ways to refer to XML parts.
// 1 -  By an index in the custom XML part collection:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->idx_get(0));
 
// 2 -  By GUID:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->GetById(xmlPartId));
 
// Add an XML schema association.
xmlPart->get_Schemas()->Add(u"http://www.w3.org/2001/XMLSchema");
 
// Clone a part, and then insert it into the collection.
SharedPtr<CustomXmlPart> xmlPartClone = xmlPart->Clone();
xmlPartClone->set_Id(System::Guid::NewGuid().ToString(u"B"));
doc->get_CustomXmlParts()->Add(xmlPartClone);
 
ASSERT_EQ(2, doc->get_CustomXmlParts()->get_Count());
 
// Iterate through the collection and print the contents of each part.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<CustomXmlPart>>> enumerator = doc->get_CustomXmlParts()->GetEnumerator();
    int index = 0;
    while (enumerator->MoveNext())
    {
        std::cout << "XML part index " << index << ", ID: " << enumerator->get_Current()->get_Id() << std::endl;
        std::cout << "\tContent: " << System::Text::Encoding::get_UTF8()->GetString(enumerator->get_Current()->get_Data()) << std::endl;
        index++;
    }
}
 
// Use the "RemoveAt" method to remove the cloned part by index.
doc->get_CustomXmlParts()->RemoveAt(1);
 
ASSERT_EQ(1, doc->get_CustomXmlParts()->get_Count());
 
// Clone the XML parts collection, and then use the "Clear" method to remove all its elements at once.
SharedPtr<CustomXmlPartCollection> customXmlParts = doc->get_CustomXmlParts()->Clone();
customXmlParts->Clear();
 
// Create a structured document tag that will display our part's contents and insert it into the document body.
auto tag = MakeObject<StructuredDocumentTag>(doc, SdtType::PlainText, MarkupLevel::Block);
tag->get_XmlMapping()->SetMapping(xmlPart, u"/root[1]/text[1]", String::Empty);
 
doc->get_FirstSection()->get_Body()->AppendChild(tag);
 
doc->Save(ArtifactsDir + u"StructuredDocumentTag.CustomXml.docx");

◆ GetType()

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

overridevirtual

Reimplemented from System::Object.

◆ idx_get()

System::SharedPtr<Aspose::Words::Markup::CustomXmlPart> Aspose::Words::Markup::CustomXmlPartCollection::idx_get ( int32_t index )

Gets or sets an item at the specified index.

Parameters

index Zero-based index of the item.

Examples

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

auto doc = MakeObject<Document>();
 
// Construct an XML part that contains data and add it to the document's collection.
// If we enable the "Developer" tab in Microsoft Word,
// we can find elements from this collection in the "XML Mapping Pane", along with a few default elements.
String xmlPartId = System::Guid::NewGuid().ToString(u"B");
String xmlPartContent = u"<root><text>Hello world!</text></root>";
SharedPtr<CustomXmlPart> xmlPart = doc->get_CustomXmlParts()->Add(xmlPartId, xmlPartContent);
 
ASPOSE_ASSERT_EQ(System::Text::Encoding::get_ASCII()->GetBytes(xmlPartContent), xmlPart->get_Data());
ASSERT_EQ(xmlPartId, xmlPart->get_Id());
 
// Below are two ways to refer to XML parts.
// 1 -  By an index in the custom XML part collection:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->idx_get(0));
 
// 2 -  By GUID:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->GetById(xmlPartId));
 
// Add an XML schema association.
xmlPart->get_Schemas()->Add(u"http://www.w3.org/2001/XMLSchema");
 
// Clone a part, and then insert it into the collection.
SharedPtr<CustomXmlPart> xmlPartClone = xmlPart->Clone();
xmlPartClone->set_Id(System::Guid::NewGuid().ToString(u"B"));
doc->get_CustomXmlParts()->Add(xmlPartClone);
 
ASSERT_EQ(2, doc->get_CustomXmlParts()->get_Count());
 
// Iterate through the collection and print the contents of each part.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<CustomXmlPart>>> enumerator = doc->get_CustomXmlParts()->GetEnumerator();
    int index = 0;
    while (enumerator->MoveNext())
    {
        std::cout << "XML part index " << index << ", ID: " << enumerator->get_Current()->get_Id() << std::endl;
        std::cout << "\tContent: " << System::Text::Encoding::get_UTF8()->GetString(enumerator->get_Current()->get_Data()) << std::endl;
        index++;
    }
}
 
// Use the "RemoveAt" method to remove the cloned part by index.
doc->get_CustomXmlParts()->RemoveAt(1);
 
ASSERT_EQ(1, doc->get_CustomXmlParts()->get_Count());
 
// Clone the XML parts collection, and then use the "Clear" method to remove all its elements at once.
SharedPtr<CustomXmlPartCollection> customXmlParts = doc->get_CustomXmlParts()->Clone();
customXmlParts->Clear();
 
// Create a structured document tag that will display our part's contents and insert it into the document body.
auto tag = MakeObject<StructuredDocumentTag>(doc, SdtType::PlainText, MarkupLevel::Block);
tag->get_XmlMapping()->SetMapping(xmlPart, u"/root[1]/text[1]", String::Empty);
 
doc->get_FirstSection()->get_Body()->AppendChild(tag);
 
doc->Save(ArtifactsDir + u"StructuredDocumentTag.CustomXml.docx");

◆ idx_set()

void Aspose::Words::Markup::CustomXmlPartCollection::idx_set	(	int32_t	index,
		const System::SharedPtr< Aspose::Words::Markup::CustomXmlPart > &	value
	)

Gets or sets an item at the specified index.

Parameters

index Zero-based index of the item.

Examples

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

auto doc = MakeObject<Document>();
 
// Construct an XML part that contains data and add it to the document's collection.
// If we enable the "Developer" tab in Microsoft Word,
// we can find elements from this collection in the "XML Mapping Pane", along with a few default elements.
String xmlPartId = System::Guid::NewGuid().ToString(u"B");
String xmlPartContent = u"<root><text>Hello world!</text></root>";
SharedPtr<CustomXmlPart> xmlPart = doc->get_CustomXmlParts()->Add(xmlPartId, xmlPartContent);
 
ASPOSE_ASSERT_EQ(System::Text::Encoding::get_ASCII()->GetBytes(xmlPartContent), xmlPart->get_Data());
ASSERT_EQ(xmlPartId, xmlPart->get_Id());
 
// Below are two ways to refer to XML parts.
// 1 -  By an index in the custom XML part collection:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->idx_get(0));
 
// 2 -  By GUID:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->GetById(xmlPartId));
 
// Add an XML schema association.
xmlPart->get_Schemas()->Add(u"http://www.w3.org/2001/XMLSchema");
 
// Clone a part, and then insert it into the collection.
SharedPtr<CustomXmlPart> xmlPartClone = xmlPart->Clone();
xmlPartClone->set_Id(System::Guid::NewGuid().ToString(u"B"));
doc->get_CustomXmlParts()->Add(xmlPartClone);
 
ASSERT_EQ(2, doc->get_CustomXmlParts()->get_Count());
 
// Iterate through the collection and print the contents of each part.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<CustomXmlPart>>> enumerator = doc->get_CustomXmlParts()->GetEnumerator();
    int index = 0;
    while (enumerator->MoveNext())
    {
        std::cout << "XML part index " << index << ", ID: " << enumerator->get_Current()->get_Id() << std::endl;
        std::cout << "\tContent: " << System::Text::Encoding::get_UTF8()->GetString(enumerator->get_Current()->get_Data()) << std::endl;
        index++;
    }
}
 
// Use the "RemoveAt" method to remove the cloned part by index.
doc->get_CustomXmlParts()->RemoveAt(1);
 
ASSERT_EQ(1, doc->get_CustomXmlParts()->get_Count());
 
// Clone the XML parts collection, and then use the "Clear" method to remove all its elements at once.
SharedPtr<CustomXmlPartCollection> customXmlParts = doc->get_CustomXmlParts()->Clone();
customXmlParts->Clear();
 
// Create a structured document tag that will display our part's contents and insert it into the document body.
auto tag = MakeObject<StructuredDocumentTag>(doc, SdtType::PlainText, MarkupLevel::Block);
tag->get_XmlMapping()->SetMapping(xmlPart, u"/root[1]/text[1]", String::Empty);
 
doc->get_FirstSection()->get_Body()->AppendChild(tag);
 
doc->Save(ArtifactsDir + u"StructuredDocumentTag.CustomXml.docx");

◆ Is()

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

overridevirtual

Reimplemented from System::Object.

◆ RemoveAt()

void Aspose::Words::Markup::CustomXmlPartCollection::RemoveAt ( int32_t index )

Removes an item at the specified index.

Parameters

index The zero based index.

Examples

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

auto doc = MakeObject<Document>();
 
// Construct an XML part that contains data and add it to the document's collection.
// If we enable the "Developer" tab in Microsoft Word,
// we can find elements from this collection in the "XML Mapping Pane", along with a few default elements.
String xmlPartId = System::Guid::NewGuid().ToString(u"B");
String xmlPartContent = u"<root><text>Hello world!</text></root>";
SharedPtr<CustomXmlPart> xmlPart = doc->get_CustomXmlParts()->Add(xmlPartId, xmlPartContent);
 
ASPOSE_ASSERT_EQ(System::Text::Encoding::get_ASCII()->GetBytes(xmlPartContent), xmlPart->get_Data());
ASSERT_EQ(xmlPartId, xmlPart->get_Id());
 
// Below are two ways to refer to XML parts.
// 1 -  By an index in the custom XML part collection:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->idx_get(0));
 
// 2 -  By GUID:
ASPOSE_ASSERT_EQ(xmlPart, doc->get_CustomXmlParts()->GetById(xmlPartId));
 
// Add an XML schema association.
xmlPart->get_Schemas()->Add(u"http://www.w3.org/2001/XMLSchema");
 
// Clone a part, and then insert it into the collection.
SharedPtr<CustomXmlPart> xmlPartClone = xmlPart->Clone();
xmlPartClone->set_Id(System::Guid::NewGuid().ToString(u"B"));
doc->get_CustomXmlParts()->Add(xmlPartClone);
 
ASSERT_EQ(2, doc->get_CustomXmlParts()->get_Count());
 
// Iterate through the collection and print the contents of each part.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<CustomXmlPart>>> enumerator = doc->get_CustomXmlParts()->GetEnumerator();
    int index = 0;
    while (enumerator->MoveNext())
    {
        std::cout << "XML part index " << index << ", ID: " << enumerator->get_Current()->get_Id() << std::endl;
        std::cout << "\tContent: " << System::Text::Encoding::get_UTF8()->GetString(enumerator->get_Current()->get_Data()) << std::endl;
        index++;
    }
}
 
// Use the "RemoveAt" method to remove the cloned part by index.
doc->get_CustomXmlParts()->RemoveAt(1);
 
ASSERT_EQ(1, doc->get_CustomXmlParts()->get_Count());
 
// Clone the XML parts collection, and then use the "Clear" method to remove all its elements at once.
SharedPtr<CustomXmlPartCollection> customXmlParts = doc->get_CustomXmlParts()->Clone();
customXmlParts->Clear();
 
// Create a structured document tag that will display our part's contents and insert it into the document body.
auto tag = MakeObject<StructuredDocumentTag>(doc, SdtType::PlainText, MarkupLevel::Block);
tag->get_XmlMapping()->SetMapping(xmlPart, u"/root[1]/text[1]", String::Empty);
 
doc->get_FirstSection()->get_Body()->AppendChild(tag);
 
doc->Save(ArtifactsDir + u"StructuredDocumentTag.CustomXml.docx");

◆ Type()

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

static

◆ virtualizeBeginConstIterator()

virtualized_iterator* Aspose::Words::Markup::CustomXmlPartCollection::virtualizeBeginConstIterator ( ) const

override

◆ virtualizeBeginIterator()

virtualized_iterator* Aspose::Words::Markup::CustomXmlPartCollection::virtualizeBeginIterator ( )

override

◆ virtualizeEndConstIterator()

virtualized_iterator* Aspose::Words::Markup::CustomXmlPartCollection::virtualizeEndConstIterator ( ) const

override

◆ virtualizeEndIterator()

virtualized_iterator* Aspose::Words::Markup::CustomXmlPartCollection::virtualizeEndIterator ( )

override

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ iterator_holder_type

◆ virtualized_iterator

◆ virtualized_iterator_element

Constructor & Destructor Documentation

◆ CustomXmlPartCollection()

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ Clear()

◆ Clone()

◆ end() [1/2]

◆ end() [2/2]

◆ get_Count()

◆ GetById()

◆ GetEnumerator()

◆ GetType()

◆ idx_get()

◆ idx_set()

◆ Is()

◆ RemoveAt()

◆ Type()

◆ virtualizeBeginConstIterator()

◆ virtualizeBeginIterator()

◆ virtualizeEndConstIterator()

◆ virtualizeEndIterator()