CustomXmlPart class

Represents a Custom XML Data Storage Part (custom XML data within a package).

public class CustomXmlPart


Name Description
CustomXmlPart() The default constructor.


Name Description
Data { get; set; } Gets or sets the XML content of this Custom XML Data Storage Part.
DataChecksum { get; } Specifies a cyclic redundancy check (CRC) checksum of the Data content.
Id { get; set; } Gets or sets the string that identifies this custom XML part within an OOXML document.
Schemas { get; } Specifies the set of XML schemas that are associated with this custom XML part.


Name Description
Clone() Makes a “deep enough” copy of the object. Does not duplicate the bytes of the Data value.


A DOCX or DOC document can contain one or more Custom XML Data Storage parts. Aspose.Words preserves and allows to create and extract Custom XML Data via the CustomXmlParts collection.


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

Document doc = new 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 = Guid.NewGuid().ToString("B");
string xmlPartContent = "<root><text>Hello world!</text></root>";
CustomXmlPart xmlPart = doc.CustomXmlParts.Add(xmlPartId, xmlPartContent);

Assert.AreEqual(Encoding.ASCII.GetBytes(xmlPartContent), xmlPart.Data);
Assert.AreEqual(xmlPartId, xmlPart.Id);

// Below are two ways to refer to XML parts.
// 1 -  By an index in the custom XML part collection:
Assert.AreEqual(xmlPart, doc.CustomXmlParts[0]);

// 2 -  By GUID:
Assert.AreEqual(xmlPart, doc.CustomXmlParts.GetById(xmlPartId));

// Add an XML schema association.

// Clone a part, and then insert it into the collection.
CustomXmlPart xmlPartClone = xmlPart.Clone();
xmlPartClone.Id = Guid.NewGuid().ToString("B");

Assert.AreEqual(2, doc.CustomXmlParts.Count);

// Iterate through the collection and print the contents of each part.
using (IEnumerator<CustomXmlPart> enumerator = doc.CustomXmlParts.GetEnumerator())
    int index = 0;
    while (enumerator.MoveNext())
        Console.WriteLine($"XML part index {index}, ID: {enumerator.Current.Id}");
        Console.WriteLine($"\tContent: {Encoding.UTF8.GetString(enumerator.Current.Data)}");

// Use the "RemoveAt" method to remove the cloned part by index.

Assert.AreEqual(1, doc.CustomXmlParts.Count);

// Clone the XML parts collection, and then use the "Clear" method to remove all its elements at once.
CustomXmlPartCollection customXmlParts = doc.CustomXmlParts.Clone();

// Create a structured document tag that will display our part's contents and insert it into the document body.
StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PlainText, MarkupLevel.Block);
tag.XmlMapping.SetMapping(xmlPart, "/root[1]/text[1]", string.Empty);


doc.Save(ArtifactsDir + "StructuredDocumentTag.CustomXml.docx");

See Also