public void CreatingCustomXml() { //ExStart //ExFor:CustomXmlPart //ExFor:CustomXmlPart.Clone //ExFor:CustomXmlPart.Data //ExFor:CustomXmlPart.Id //ExFor:CustomXmlPart.Schemas //ExFor:CustomXmlPartCollection //ExFor:CustomXmlPartCollection.Add(CustomXmlPart) //ExFor:CustomXmlPartCollection.Add(String, String) //ExFor:CustomXmlPartCollection.Clear //ExFor:CustomXmlPartCollection.Clone //ExFor:CustomXmlPartCollection.Count //ExFor:CustomXmlPartCollection.GetById(String) //ExFor:CustomXmlPartCollection.GetEnumerator //ExFor:CustomXmlPartCollection.Item(Int32) //ExFor:CustomXmlPartCollection.RemoveAt(Int32) //ExFor:Document.CustomXmlParts //ExFor:StructuredDocumentTag.XmlMapping //ExFor:XmlMapping.SetMapping(CustomXmlPart, String, String) //ExSummary:Shows how to create structured document tag with a custom XML data. Document doc = new Document(); // Construct an XML part that contains data and add it to the document's collection // Once the "Developer" tab in Microsoft Word is enabled, // we can find elements from this collection as well as a couple defaults in the "XML Mapping Pane" string xmlPartId = Guid.NewGuid().ToString("B"); string xmlPartContent = "<root><text>Hello world!</text></root>"; CustomXmlPart xmlPart = doc.CustomXmlParts.Add(xmlPartId, xmlPartContent); // The data we entered is stored in these attributes Assert.AreEqual(Encoding.ASCII.GetBytes(xmlPartContent), xmlPart.Data); Assert.AreEqual(xmlPartId, xmlPart.Id); // XML parts can be referenced by collection index or GUID Assert.AreEqual(xmlPart, doc.CustomXmlParts[0]); Assert.AreEqual(xmlPart, doc.CustomXmlParts.GetById(xmlPartId)); // Once the part is created, we can add XML schema associations like this xmlPart.Schemas.Add("http://www.w3.org/2001/XMLSchema"); // We can also clone parts and insert them into the collection directly CustomXmlPart xmlPartClone = xmlPart.Clone(); xmlPartClone.Id = Guid.NewGuid().ToString("B"); doc.CustomXmlParts.Add(xmlPartClone); Assert.AreEqual(2, doc.CustomXmlParts.Count); // Iterate through collection with an enumerator 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++; } } // XML parts can be removed by index doc.CustomXmlParts.RemoveAt(1); Assert.AreEqual(1, doc.CustomXmlParts.Count); // The XML part collection itself can be cloned also CustomXmlPartCollection customXmlParts = doc.CustomXmlParts.Clone(); // And all elements can be cleared like this customXmlParts.Clear(); // Create a StructuredDocumentTag that will display the contents of our part, // insert it into the document and save the document 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"); //ExEnd Assert.IsTrue(DocumentHelper.CompareDocs(ArtifactsDir + "StructuredDocumentTag.CustomXml.docx", GoldsDir + "StructuredDocumentTag.CustomXml Gold.docx")); doc = new Document(ArtifactsDir + "StructuredDocumentTag.CustomXml.docx"); xmlPart = doc.CustomXmlParts[0]; Assert.True(Guid.TryParse(xmlPart.Id, out Guid temp)); Assert.AreEqual("<root><text>Hello world!</text></root>", Encoding.UTF8.GetString(xmlPart.Data)); Assert.AreEqual("http://www.w3.org/2001/XMLSchema", xmlPart.Schemas[0]); tag = (StructuredDocumentTag)doc.GetChild(NodeType.StructuredDocumentTag, 0, true); Assert.AreEqual("Hello world!", tag.GetText().Trim()); Assert.AreEqual("/root[1]/text[1]", tag.XmlMapping.XPath); Assert.AreEqual(string.Empty, tag.XmlMapping.PrefixMappings); }
public void CreatingCustomXml() { //ExStart //ExFor:CustomXmlPart //ExFor:CustomXmlPart.Clone //ExFor:CustomXmlPart.Data //ExFor:CustomXmlPart.Id //ExFor:CustomXmlPart.Schemas //ExFor:CustomXmlPartCollection //ExFor:CustomXmlPartCollection.Add(CustomXmlPart) //ExFor:CustomXmlPartCollection.Add(String, String) //ExFor:CustomXmlPartCollection.Clear //ExFor:CustomXmlPartCollection.Clone //ExFor:CustomXmlPartCollection.Count //ExFor:CustomXmlPartCollection.GetById(String) //ExFor:CustomXmlPartCollection.GetEnumerator //ExFor:CustomXmlPartCollection.Item(Int32) //ExFor:CustomXmlPartCollection.RemoveAt(Int32) //ExFor:Document.CustomXmlParts //ExFor:StructuredDocumentTag.XmlMapping //ExFor:XmlMapping.SetMapping(CustomXmlPart, String, String) //ExSummary: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"); //ExEnd Assert.IsTrue(DocumentHelper.CompareDocs(ArtifactsDir + "StructuredDocumentTag.CustomXml.docx", GoldsDir + "StructuredDocumentTag.CustomXml Gold.docx")); doc = new Document(ArtifactsDir + "StructuredDocumentTag.CustomXml.docx"); xmlPart = doc.CustomXmlParts[0]; Assert.True(Guid.TryParse(xmlPart.Id, out Guid temp)); Assert.AreEqual("<root><text>Hello world!</text></root>", Encoding.UTF8.GetString(xmlPart.Data)); Assert.AreEqual("http://www.w3.org/2001/XMLSchema", xmlPart.Schemas[0]); tag = (StructuredDocumentTag)doc.GetChild(NodeType.StructuredDocumentTag, 0, true); Assert.AreEqual("Hello world!", tag.GetText().Trim()); Assert.AreEqual("/root[1]/text[1]", tag.XmlMapping.XPath); Assert.AreEqual(string.Empty, tag.XmlMapping.PrefixMappings); }