Add Custom XML Parts and Select them by ID with C++

Possible Usage Scenarios

Custom XML Parts are XML data stored inside Microsoft Excel documents and are used by applications that interact with them. There is no direct way to add them using the Microsoft Excel UI at the moment. However, you can add them programmatically in various ways, such as using VSTO or Aspose.Cells. Use the Workbook.CustomXmlParts.Add() method to add a Custom XML Part using the Aspose.Cells API. You can also set its ID using the CustomXmlPart.GetID() property. Similarly, if you want to select a Custom XML Part by ID, you can use the Workbook.CustomXmlParts.SelectByID() method.

Add Custom XML Parts and Select them by ID

The following sample code first adds four Custom XML Parts using the Workbook.CustomXmlParts.Add() method. It then sets their IDs using the CustomXmlPart.GetID() property. Finally, it finds or selects one of the added Custom XML Parts using the Workbook.CustomXmlParts.SelectByID() method. Please also see the console output of the code given below for reference.

Sample Code

#include <iostream>
#include "Aspose.Cells.h"

using namespace Aspose::Cells;
using namespace Aspose::Cells::Markup;

int main()
{
    Aspose::Cells::Startup();

    // Create empty workbook
    Workbook wb;

    // Some data in the form of byte array
    // Please use correct XML and Schema instead
    Vector<uint8_t> btsData = { 1, 2, 3 };
    Vector<uint8_t> btsSchema = { 1, 2, 3 };

    // Create four custom xml parts
    wb.GetCustomXmlParts().Add(btsData, btsSchema);
    wb.GetCustomXmlParts().Add(btsData, btsSchema);
    wb.GetCustomXmlParts().Add(btsData, btsSchema);
    wb.GetCustomXmlParts().Add(btsData, btsSchema);

    // Assign ids to custom xml parts
    wb.GetCustomXmlParts().Get(0).SetID(u"Fruit");
    wb.GetCustomXmlParts().Get(1).SetID(u"Color");
    wb.GetCustomXmlParts().Get(2).SetID(u"Sport");
    wb.GetCustomXmlParts().Get(3).SetID(u"Shape");

    // Specify search custom xml part id
    U16String srchID = u"Fruit";
    srchID = u"Color";
    srchID = u"Sport";

    // Search custom xml part by the search id
    CustomXmlPart cxp = wb.GetCustomXmlParts().SelectByID(srchID);

    // Print the found or not found message on console
    if (cxp.IsNull())
    {
        std::cout << "Not Found: CustomXmlPart ID " << srchID.ToUtf8() << std::endl;
    }
    else
    {
        std::cout << "Found: CustomXmlPart ID " << srchID.ToUtf8() << std::endl;
    }

    std::cout << "AddCustomXMLPartsAndSelectThemByID executed successfully." << std::endl;

    Aspose::Cells::Cleanup();
}

Console Output

Found: CustomXmlPart ID Sport