CustomXmlActions.vb

Imports DevExpress.XtraRichEdit
Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Text
Imports System.Threading.Tasks
Imports System.Xml
Imports DevExpress.XtraRichEdit.API.Native

Namespace RichEditDocumentServerAPIExample.CodeExamples

    Friend Class CustomXmlActions

        Public Shared AddCustomXmlPartAction As System.Action(Of DevExpress.XtraRichEdit.RichEditDocumentServer) = AddressOf RichEditDocumentServerAPIExample.CodeExamples.CustomXmlActions.AddCustomXmlPart

        Public Shared AccessCustomXmlPartAction As System.Action(Of DevExpress.XtraRichEdit.RichEditDocumentServer) = AddressOf RichEditDocumentServerAPIExample.CodeExamples.CustomXmlActions.AccessCustomXmlPart

        Public Shared RemoveCustomXmlPartAction As System.Action(Of DevExpress.XtraRichEdit.RichEditDocumentServer) = AddressOf RichEditDocumentServerAPIExample.CodeExamples.CustomXmlActions.RemoveCustomXmlPart

        Private Shared Sub AddCustomXmlPart(ByVal wordProcessor As DevExpress.XtraRichEdit.RichEditDocumentServer)
#Region "#AddCustomXmlPart"
            ' Access a document.
            Dim document As DevExpress.XtraRichEdit.API.Native.Document = wordProcessor.Document
            ' Append text to the document.
            document.AppendText("This document contains custom XML parts.")
            ' Add an empty custom XML part.
            Dim xmlItem As DevExpress.XtraRichEdit.API.Native.ICustomXmlPart = document.CustomXmlParts.Add()
            ' Populate the XML part with content.
            Dim elem As System.Xml.XmlElement = xmlItem.CustomXmlPartDocument.CreateElement("Employees")
            elem.InnerText = "Stephen Edwards"
            xmlItem.CustomXmlPartDocument.AppendChild(elem)
            ' Specify the custom XML part content.
            Dim xmlString As String = "<?xml version=""1.0"" encoding=""UTF-8""?>
                            <Employees>
                                <FirstName>Stephen</FirstName>
                                <LastName>Edwards</LastName>
                                <Address>4726 - 11th Ave. N.E.</Address>
                                <City>Seattle</City>
                                <Region>WA</Region>
                                <PostalCode>98122</PostalCode>
                                <Country>USA</Country>
                            </Employees>"
            document.CustomXmlParts.Insert(1, xmlString)
            ' Add a custom XML part from a file.
            Dim xmlDoc As System.Xml.XmlDocument = New System.Xml.XmlDocument()
            xmlDoc.Load("Documents\Employees.xml")
            document.CustomXmlParts.Add(xmlDoc)
#End Region  ' #AddCustomXmlPart
        End Sub

        Private Shared Sub AccessCustomXmlPart(ByVal wordProcessor As DevExpress.XtraRichEdit.RichEditDocumentServer)
#Region "#AccessCustomXmlPart"
            ' Load a document from a file.
            wordProcessor.LoadDocument("Documents\Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
            ' Access a document.
            Dim document As DevExpress.XtraRichEdit.API.Native.Document = wordProcessor.Document
            If document.CustomXmlParts.Count > 0 Then
                ' Access a custom XML file stored in the document.
                Dim xmlDoc As System.Xml.XmlDocument = document.CustomXmlParts(CInt((0))).CustomXmlPartDocument
                ' Retrieve employee names from the XML file and display them in the document.
                Dim nameList As System.Xml.XmlNodeList = xmlDoc.GetElementsByTagName("Name")
                document.AppendText("Employee list:")
                For Each name As System.Xml.XmlNode In nameList
                    document.AppendText(Global.Microsoft.VisualBasic.Constants.vbCrLf & " · " & name.InnerText)
                Next
            End If
#End Region  ' #AccessCustomXmlPart
        End Sub

        Private Shared Sub RemoveCustomXmlPart(ByVal wordProcessor As DevExpress.XtraRichEdit.RichEditDocumentServer)
#Region "#RemoveCustomXmlPart"
            ' Access a document.
            Dim document As DevExpress.XtraRichEdit.API.Native.Document = wordProcessor.Document
            ' Append text to the document.
            document.AppendText("This document contains custom XML parts.")
            ' Add the first custom XML part.
            Dim xmlString1 As String = "<?xml version=""1.0"" encoding=""UTF-8""?>
                            <Employees>
                                <FirstName>Stephen</FirstName>
                                <LastName>Edwards</LastName>
                            </Employees>"
            Dim xmlItem1 = document.CustomXmlParts.Add(xmlString1)
            ' Add the second custom XML part.
            Dim xmlString2 As String = "<?xml version=""1.0"" encoding=""UTF-8""?>
                            <Employees>
                                <FirstName>Andrew</FirstName>
                                <LastName>Fuller</LastName>
                            </Employees>"
            Dim xmlItem2 = document.CustomXmlParts.Add(xmlString2)
            ' Remove the first item from the collection.
            document.CustomXmlParts.Remove(xmlItem1)
        ' Use the RemoveAt method to remove an item at the specified position from the collection.
        ' document.CustomXmlParts.RemoveAt(0);
        ' Use the Clear method to remove all items from the collection.
        ' document.CustomXmlParts.Clear();
#End Region  ' #RemoveCustomXmlPart
        End Sub
    End Class
End Namespace