# GrapeCity.Documents.Word.Fields.IndexEntry

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="GrapeCity_Documents_Word_Fields_IndexEntry" data-uid="GrapeCity.Documents.Word.Fields.IndexEntry" class="text-break">IndexEntry Class
</h1>
  <div class="markdown level0 summary"><p>Represents a multi-level index entry.</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">IndexEntry</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="GrapeCity.Documents.Word.Fields.html">GrapeCity.Documents.Word.Fields</a></h6>
  <h6><strong>Assembly</strong>: DS.Documents.Word.dll</h6>
  <h5 id="GrapeCity_Documents_Word_Fields_IndexEntry_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class IndexEntry</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class IndexEntry</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_Fields_IndexEntry_Content" data-uid="GrapeCity.Documents.Word.Fields.IndexEntry.Content">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexEntry.Content.html#GrapeCity_Documents_Word_Fields_IndexEntry_Content">Content</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the formatted content of the index entry.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexEntry_Level" data-uid="GrapeCity.Documents.Word.Fields.IndexEntry.Level">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexEntry.Level.html#GrapeCity_Documents_Word_Fields_IndexEntry_Level">Level</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the level of the index entry.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexEntry_Parent" data-uid="GrapeCity.Documents.Word.Fields.IndexEntry.Parent">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexEntry.Parent.html#GrapeCity_Documents_Word_Fields_IndexEntry_Parent">Parent</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the parent index entry.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexEntry_SortBy" data-uid="GrapeCity.Documents.Word.Fields.IndexEntry.SortBy">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexEntry.SortBy.html#GrapeCity_Documents_Word_Fields_IndexEntry_SortBy">SortBy</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the string to sort entry in the INDEX field result.</p>
<p>The value of this property is invisible in the INDEX field result but allows changing the index entry sorting order.</p>
<p>Note that entries with the same <span class="xref">GrapeCity.Documents.Word.Fields.IndexEntry.Text</span> but different <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexEntry.SortBy.html#GrapeCity_Documents_Word_Fields_IndexEntry_SortBy">SortBy</a> values are not grouped together.</p>
<p>Default value is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexEntry_SubEntry" data-uid="GrapeCity.Documents.Word.Fields.IndexEntry.SubEntry">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexEntry.SubEntry.html#GrapeCity_Documents_Word_Fields_IndexEntry_SubEntry">SubEntry</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the sub index entry.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexEntry_Yomi" data-uid="GrapeCity.Documents.Word.Fields.IndexEntry.Yomi">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexEntry.Yomi.html#GrapeCity_Documents_Word_Fields_IndexEntry_Yomi">Yomi</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the yomi (first phonetic character for sorting indexes) for the index entry.</p>
<p>While the <span class="xref">GrapeCity.Documents.Word.Fields.IndexEntry.Text</span> property may contain a word's spelling in Kanji, whose pronunciation may be ambiguous,
the "Yomi" version of the word will spell exactly how it is pronounced using Hiragana.</p>
<p>Default value is space for the first and last level. For other levels default value is <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string.empty">Empty</a>.</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_Fields_IndexEntry_AddSubEntry_System_String_" data-uid="GrapeCity.Documents.Word.Fields.IndexEntry.AddSubEntry(System.String)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexEntry.AddSubEntry.html#GrapeCity_Documents_Word_Fields_IndexEntry_AddSubEntry_System_String_">AddSubEntry(string)</a>
        </td>
        <td class="markdown level1 summary"><p>Adds a sub index entry.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexEntry_AddSubEntry_System_String_System_String_" data-uid="GrapeCity.Documents.Word.Fields.IndexEntry.AddSubEntry(System.String,System.String)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexEntry.AddSubEntry.html#GrapeCity_Documents_Word_Fields_IndexEntry_AddSubEntry_System_String_System_String_">AddSubEntry(string, string)</a>
        </td>
        <td class="markdown level1 summary"><p>Adds a sub index entry.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexEntry_RemoveSubEntry" data-uid="GrapeCity.Documents.Word.Fields.IndexEntry.RemoveSubEntry">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexEntry.RemoveSubEntry.html#GrapeCity_Documents_Word_Fields_IndexEntry_RemoveSubEntry">RemoveSubEntry()</a>
        </td>
        <td class="markdown level1 summary"><p>Removes the sub index entry.</p>
<p>If the sub entry has its own sub entry, it becomes the sub entry for this entry.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexEntry_ToString" data-uid="GrapeCity.Documents.Word.Fields.IndexEntry.ToString">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexEntry.ToString.html#GrapeCity_Documents_Word_Fields_IndexEntry_ToString">ToString()</a>
        </td>
        <td class="markdown level1 summary"></td>
      </tr>
    </tbody>
  </table>

</div>
