# GrapeCity.Documents.Word.Fields.IndexFieldOptions

## Content

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



  <h1 id="GrapeCity_Documents_Word_Fields_IndexFieldOptions" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions" class="text-break">IndexFieldOptions Class
</h1>
  <div class="markdown level0 summary"><p>Represents INDEX field options.</p>
<p>The INDEX field builds an index using the index entries specified by XE fields (see <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.html">XeFieldOptions</a>),
and inserts that index at its place 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"><a class="xref" href="GrapeCity.Documents.Word.Fields.BaseFieldOptions.html">BaseFieldOptions</a></div>
    <div class="level2"><span class="xref">IndexFieldOptions</span></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="GrapeCity.Documents.Word.Fields.IFieldOptions.html">IFieldOptions</a></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_IndexFieldOptions_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class IndexFieldOptions : BaseFieldOptions, IFieldOptions</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class IndexFieldOptions
    Inherits BaseFieldOptions
    Implements IFieldOptions</code></pre>
  </div>
  <h3 id="constructors">Constructors
</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_IndexFieldOptions__ctor_GrapeCity_Documents_Word_ComplexField_" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.#ctor(GrapeCity.Documents.Word.ComplexField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.-ctor.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions__ctor_GrapeCity_Documents_Word_ComplexField_">IndexFieldOptions(ComplexField)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.html">IndexFieldOptions</a> class.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexFieldOptions__ctor_GrapeCity_Documents_Word_DocumentBase_" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.#ctor(GrapeCity.Documents.Word.DocumentBase)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.-ctor.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions__ctor_GrapeCity_Documents_Word_DocumentBase_">IndexFieldOptions(DocumentBase)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.html">IndexFieldOptions</a> class.</p>
<param name="doc">The document that provides resources and context for this instance.
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexFieldOptions__ctor_GrapeCity_Documents_Word_SimpleField_" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.#ctor(GrapeCity.Documents.Word.SimpleField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.-ctor.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions__ctor_GrapeCity_Documents_Word_SimpleField_">IndexFieldOptions(SimpleField)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.html">IndexFieldOptions</a> class.</p>
</td>
      </tr>
    </tbody>
  </table>
  <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_IndexFieldOptions_Bookmark" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Bookmark">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Bookmark.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_Bookmark">Bookmark</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the name of a bookmark which allows including entries only from the portion of the document marked by this bookmark.</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_IndexFieldOptions_CharacterRange" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.CharacterRange">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.CharacterRange.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_CharacterRange">CharacterRange</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the range of characters, only entries with first letters within that range will be included in the index.</p>
<p>Default value is <a class="xref" href="GrapeCity.Documents.Word.Fields.CharacterRange.IsAll.html#GrapeCity_Documents_Word_Fields_CharacterRange_IsAll">IsAll</a>, which includes all entries.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexFieldOptions_Columns" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Columns">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Columns.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_Columns">Columns</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the number of columns per page.</p>
<p>Allowed values are from <b>1</b> to <b>4</b>, inclusive.</p>
<p>If the value is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a> the index result does not change the current number of columns.</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_IndexFieldOptions_Culture" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Culture">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Culture.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_Culture">Culture</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo">CultureInfo</a> that is used to sort the index entries.</p>
<p>If <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>, the culture specified when updating the field
(see <a class="xref" href="GrapeCity.Documents.Word.Layout.WordLayoutSettings.Culture.html#GrapeCity_Documents_Word_Layout_WordLayoutSettings_Culture">Culture</a>) is used.</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_IndexFieldOptions_EntriesType" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.EntriesType">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.EntriesType.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_EntriesType">EntriesType</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value specifying what type of XE fields to collect.
If not <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>, only XE entries with <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Type.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_Type">Type</a>
equal to the value of this property will be included in the index.</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_IndexFieldOptions_FlatList" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.FlatList">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.FlatList.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_FlatList">FlatList</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether subentries run in the same line as the main entry.</p>
<p>If <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>, colons (<b>':'</b>) separate main entries from subentries,
while semicolons (<b>';'</b>) separate subentries.</p>
<p>Default value is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexFieldOptions_Heading" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Heading">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Heading.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_Heading">Heading</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a heading text which appears at the start of each set of entries for any given letter.</p>
<p>If the first letter in the text is <b>A</b> or <b>a</b>,
that letter will be replaced with the corresponding letter for each letter set.</p>
<p>Default value is <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string.empty">Empty</a> (no headings).</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexFieldOptions_PageNumbers" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.PageNumbers">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.PageNumbers.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_PageNumbers">PageNumbers</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the options used to show page numbers in the index.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexFieldOptions_UseYomi" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.UseYomi">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.UseYomi.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_UseYomi">UseYomi</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether to use <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexEntry.Yomi.html#GrapeCity_Documents_Word_Fields_IndexEntry_Yomi">Yomi</a> to sort the index entries.</p>
<p>Default value is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</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_IndexFieldOptions_Load_GrapeCity_Documents_Word_ComplexField_" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Load(GrapeCity.Documents.Word.ComplexField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Load.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_Load_GrapeCity_Documents_Word_ComplexField_">Load(ComplexField)</a>
        </td>
        <td class="markdown level1 summary"><p>Loads options from the specified <a class="xref" href="GrapeCity.Documents.Word.ComplexField.html">ComplexField</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexFieldOptions_Load_GrapeCity_Documents_Word_SimpleField_" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Load(GrapeCity.Documents.Word.SimpleField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Load.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_Load_GrapeCity_Documents_Word_SimpleField_">Load(SimpleField)</a>
        </td>
        <td class="markdown level1 summary"><p>Loads options from the specified <a class="xref" href="GrapeCity.Documents.Word.SimpleField.html">SimpleField</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexFieldOptions_Save_GrapeCity_Documents_Word_ComplexField_" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Save(GrapeCity.Documents.Word.ComplexField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Save.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_Save_GrapeCity_Documents_Word_ComplexField_">Save(ComplexField)</a>
        </td>
        <td class="markdown level1 summary"><p>Saves the current options to the specified <a class="xref" href="GrapeCity.Documents.Word.ComplexField.html">ComplexField</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexFieldOptions_Save_GrapeCity_Documents_Word_SimpleField_" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Save(GrapeCity.Documents.Word.SimpleField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.Save.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_Save_GrapeCity_Documents_Word_SimpleField_">Save(SimpleField)</a>
        </td>
        <td class="markdown level1 summary"><p>Saves the current options to the specified <a class="xref" href="GrapeCity.Documents.Word.SimpleField.html">SimpleField</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_IndexFieldOptions_ToString" data-uid="GrapeCity.Documents.Word.Fields.IndexFieldOptions.ToString">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.ToString.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_ToString">ToString()</a>
        </td>
        <td class="markdown level1 summary"></td>
      </tr>
    </tbody>
  </table>

</div>