ICustomXmlPart Interface

A custom XML part embedded in a document.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public interface ICustomXmlPart :
    OfficeCustomXmlPart<ICustomXmlPart>,
    OfficeCustomXmlPart

VB.NET

Public Interface ICustomXmlPart
    Inherits OfficeCustomXmlPart(Of ICustomXmlPart),
             OfficeCustomXmlPart

Remarks

You can embed arbitrary XML data (called custom XML parts) in documents in DOCX and DOC format. Custom XML parts are included in the document structure but are not visible in the document.

The image below shows the structure of a DOCX file with three custom XML parts (item1, item2, and item3).

A custom XML part is an object that exposes the ICustomXmlPart interface. Use the Document.CustomXmlParts property to access the CustomXmlPartCollection collection that stores custom XML parts.

You can use a custom XML part’s index to obtain it from the collection. Use the CustomXmlPartDocument property to access an XML document associated with the ICustomXmlPart object.

C#

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
using System.Xml;
// ...

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    Document document = wordProcessor.Document;
    // Load a document.
    document.LoadDocument("Documents\\CustomXmlParts.docx");
    // Access a custom XML file stored in the document.
    XmlDocument xmlDoc = document.CustomXmlParts[0].CustomXmlPartDocument;
    // Retrieve employee names from the XML file and display them in the document.
    XmlNodeList nameList = xmlDoc.GetElementsByTagName("Name");
    document.AppendText("Employee list:");
    foreach (XmlNode name in nameList)
    {
        document.AppendText("\r\n \u00B7 " + name.InnerText);
    }
}

VB.NET

Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
Imports System.Xml
' ...

Using wordProcessor As New RichEditDocumentServer()
    Dim document As Document = wordProcessor.Document
    ' Load a document.
    document.LoadDocument("Documents\CustomXmlParts.docx")
    ' Access a custom XML file stored in the document.
    Dim xmlDoc As XmlDocument = document.CustomXmlParts(0).CustomXmlPartDocument
    ' Retrieve employee names from the XML file and display them in the document.
    Dim nameList As XmlNodeList = xmlDoc.GetElementsByTagName("Name")
    document.AppendText("Employee list:")
    For Each name As XmlNode In nameList
        document.AppendText(ControlChars.CrLf & " " & ChrW(&H00B7).ToString() & " " & name.InnerText)
    Next name
End Using