CustomXmlPartCollection
Contents
[
Hide
]CustomXmlPartCollection class
Represents a collection of Custom XML Parts. The items are CustomXmlPart
objects.
To learn more, visit the Structured Document Tags or Content Control documentation article.
public class CustomXmlPartCollection : IEnumerable<CustomXmlPart>
Constructors
Name | Description |
---|---|
CustomXmlPartCollection() | The default constructor. |
Properties
Name | Description |
---|---|
Count { get; } | Gets the number of elements contained in the collection. |
Item { get; set; } | Gets or sets an item at the specified index. |
Methods
Name | Description |
---|---|
Add(CustomXmlPart) | Adds an item to the collection. |
Add(string, string) | Creates a new XML part with the specified XML and adds it to the collection. |
Clear() | Removes all elements from the collection. |
Clone() | Makes a deep copy of this collection and its items. |
GetById(string) | Finds and returns a custom XML part by its identifier. |
GetEnumerator() | Returns an enumerator object that can be used to iterate over all items in the collection. |
RemoveAt(int) | Removes an item at the specified index. |
Remarks
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.
Examples
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.
xmlPart.Schemas.Add("http://www.w3.org/2001/XMLSchema");
// Clone a part, and then insert it into the collection.
CustomXmlPart xmlPartClone = xmlPart.Clone();
xmlPartClone.Id = Guid.NewGuid().ToString("B");
doc.CustomXmlParts.Add(xmlPartClone);
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)}");
index++;
}
}
// Use the "RemoveAt" method to remove the cloned part by index.
doc.CustomXmlParts.RemoveAt(1);
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();
customXmlParts.Clear();
// 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.FirstSection.Body.AppendChild(tag);
doc.Save(ArtifactsDir + "StructuredDocumentTag.CustomXml.docx");
See Also
- class CustomXmlPart
- namespace Aspose.Words.Markup
- assembly Aspose.Words