# GrapeCity.Documents.Word.XmlMapping

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="GrapeCity_Documents_Word_XmlMapping" data-uid="GrapeCity.Documents.Word.XmlMapping" class="text-break">XmlMapping Class
</h1>
  <div class="markdown level0 summary"><p>Specifies the information which shall be used to establish a mapping between a content control and an XML node stored within a Custom XML Data part in the document.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><span class="xref">XmlMapping</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="GrapeCity.Documents.Word.html">GrapeCity.Documents.Word</a></h6>
  <h6><strong>Assembly</strong>: DS.Documents.Word.dll</h6>
  <h5 id="GrapeCity_Documents_Word_XmlMapping_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class XmlMapping</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class XmlMapping</code></pre>
  </div>
  <h3 id="properties">Properties
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_CustomXmlPartId" data-uid="GrapeCity.Documents.Word.XmlMapping.CustomXmlPartId">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.CustomXmlPartId.html#GrapeCity_Documents_Word_XmlMapping_CustomXmlPartId">CustomXmlPartId</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the identifier of the <a class="xref" href="GrapeCity.Documents.Word.CustomXmlPart.html">CustomXmlPart</a> which shall be used to evaluate the given <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.XPath.html#GrapeCity_Documents_Word_XmlMapping_XPath">XPath</a> property.
If specified, then the XPath expression specified in the <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.XPath.html#GrapeCity_Documents_Word_XmlMapping_XPath">XPath</a> property shall only be
evaluated against the custom XML part whose properties part has a matching identifier.
If no custom XML part exists with a matching identifier, then the XML mapping shall not be connected.
If value is null or empty, then the XPath expression shall be evaluated against each custom XML data part
in turn until the given XPath expression is resolved to an XML node.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_IsMapped" data-uid="GrapeCity.Documents.Word.XmlMapping.IsMapped">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.IsMapped.html#GrapeCity_Documents_Word_XmlMapping_IsMapped">IsMapped</a>
        </td>
        <td class="markdown level1 summary"><p>Gets whether a mapping between a content control and an XML node stored within a Custom XML Data part
in the document is established successfully.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_PrefixMappings" data-uid="GrapeCity.Documents.Word.XmlMapping.PrefixMappings">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.PrefixMappings.html#GrapeCity_Documents_Word_XmlMapping_PrefixMappings">PrefixMappings</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the set of prefix mappings which shall be used to interpret the XPath expression specified
on the <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.XPath.html#GrapeCity_Documents_Word_XmlMapping_XPath">XPath</a> property when the XPath expression is evaluated against the custom XML data parts in the document.
This property value shall be specified using the following syntax: xmlns:prefix='namespace',
where prefix is the namespace prefix to be mapped, and namespace is the namespace to be mapped to
the current prefix.
Each prefix mapping shall be delimited by one or more whitespace characters.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_SupportRichTextControl" data-uid="GrapeCity.Documents.Word.XmlMapping.SupportRichTextControl">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.SupportRichTextControl.html#GrapeCity_Documents_Word_XmlMapping_SupportRichTextControl">SupportRichTextControl</a>
        </td>
        <td class="markdown level1 summary"><p>Gets whether the xml mapping supports a content control with <a class="xref" href="GrapeCity.Documents.Word.ContentControlType.html#GrapeCity_Documents_Word_ContentControlType_RichText">RichText</a> type.
if false (default), the rich text content controls are not supported, so no data stored in the XML node is
mapped for this kind of controls.
if true, the data stored in the XML node will be an escaped string comprised of a flattened document
representing the formatted data in the content control range.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_XPath" data-uid="GrapeCity.Documents.Word.XmlMapping.XPath">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.XPath.html#GrapeCity_Documents_Word_XmlMapping_XPath">XPath</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the XPath expression which shall be evaluated to find the custom XML node which is mapped to the
content control.
This XPath expression shall be specified using the syntax defined in the XML Path Language (XPath)
Version 1.0 specification.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_Clear" data-uid="GrapeCity.Documents.Word.XmlMapping.Clear">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.Clear.html#GrapeCity_Documents_Word_XmlMapping_Clear">Clear()</a>
        </td>
        <td class="markdown level1 summary"><p>Removes mapping between a content control and an XML node stored within a Custom XML Data part in the document.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_Equals_System_Object_" data-uid="GrapeCity.Documents.Word.XmlMapping.Equals(System.Object)">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.Equals.html#GrapeCity_Documents_Word_XmlMapping_Equals_System_Object_">Equals(object)</a>
        </td>
        <td class="markdown level1 summary"><p>Determines whether the specified object is equal to the current object.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_GetHashCode" data-uid="GrapeCity.Documents.Word.XmlMapping.GetHashCode">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.GetHashCode.html#GrapeCity_Documents_Word_XmlMapping_GetHashCode">GetHashCode()</a>
        </td>
        <td class="markdown level1 summary"><p>Serves as the default hash function.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_SetMapping_System_String_System_String_System_String_System_Boolean_" data-uid="GrapeCity.Documents.Word.XmlMapping.SetMapping(System.String,System.String,System.String,System.Boolean)">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.SetMapping.html#GrapeCity_Documents_Word_XmlMapping_SetMapping_System_String_System_String_System_String_System_Boolean_">SetMapping(string, string, string, bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Set mapping between a content control and an XML node stored within a Custom XML Data part in the document.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_SetMapping_System_Xml_XmlNode_System_String_System_Boolean_" data-uid="GrapeCity.Documents.Word.XmlMapping.SetMapping(System.Xml.XmlNode,System.String,System.Boolean)">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.SetMapping.html#GrapeCity_Documents_Word_XmlMapping_SetMapping_System_Xml_XmlNode_System_String_System_Boolean_">SetMapping(XmlNode, string, bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Set mapping between a content control and an XML node stored within a Custom XML Data part in the document.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_SetMapping__1_System_Linq_Expressions_Expression_System_Func___0___System_Boolean_" data-uid="GrapeCity.Documents.Word.XmlMapping.SetMapping``1(System.Linq.Expressions.Expression{System.Func{``0}},System.Boolean)">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.SetMapping.html#GrapeCity_Documents_Word_XmlMapping_SetMapping__1_System_Linq_Expressions_Expression_System_Func___0___System_Boolean_">SetMapping&lt;T&gt;(Expression&lt;Func&lt;T&gt;&gt;, bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Set mapping between a content control and an XML node stored within a Custom XML Data part in the document.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_TryGetValue_System_String__" data-uid="GrapeCity.Documents.Word.XmlMapping.TryGetValue(System.String@)">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.TryGetValue.html#GrapeCity_Documents_Word_XmlMapping_TryGetValue_System_String__">TryGetValue(out string)</a>
        </td>
        <td class="markdown level1 summary"><p>Tries get inner xml of the mapped node stored within a <a class="xref" href="GrapeCity.Documents.Word.CustomXmlPart.XmlDocument.html#GrapeCity_Documents_Word_CustomXmlPart_XmlDocument">XmlDocument</a> in the document.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_XmlMapping_TrySetValue_System_String_" data-uid="GrapeCity.Documents.Word.XmlMapping.TrySetValue(System.String)">
          <a class="xref" href="GrapeCity.Documents.Word.XmlMapping.TrySetValue.html#GrapeCity_Documents_Word_XmlMapping_TrySetValue_System_String_">TrySetValue(string)</a>
        </td>
        <td class="markdown level1 summary"><p>Tries set inner xml to the mapped node stored within a <a class="xref" href="GrapeCity.Documents.Word.CustomXmlPart.XmlDocument.html#GrapeCity_Documents_Word_CustomXmlPart_XmlDocument">XmlDocument</a> in the document.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>