# GrapeCity.Documents.Word.Fields.TocFieldOptions

## Content

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



  <h1 id="GrapeCity_Documents_Word_Fields_TocFieldOptions" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions" class="text-break">TocFieldOptions Class
</h1>
  <div class="markdown level0 summary"><p>Represents TOC field options.</p>
<p>A TOC field builds a table of contents (which can also be a table of figures) using the entries specified by TC fields, 
their heading levels, and specified styles, and inserts that table at its place in the document. Each table entry is a separate paragraph.</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">TocFieldOptions</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_TocFieldOptions_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class TocFieldOptions : BaseFieldOptions, IFieldOptions</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class TocFieldOptions
    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_TocFieldOptions__ctor_GrapeCity_Documents_Word_ComplexField_" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.#ctor(GrapeCity.Documents.Word.ComplexField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.-ctor.html#GrapeCity_Documents_Word_Fields_TocFieldOptions__ctor_GrapeCity_Documents_Word_ComplexField_">TocFieldOptions(ComplexField)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.html">TocFieldOptions</a> class.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_TocFieldOptions__ctor_GrapeCity_Documents_Word_DocumentBase_" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.#ctor(GrapeCity.Documents.Word.DocumentBase)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.-ctor.html#GrapeCity_Documents_Word_Fields_TocFieldOptions__ctor_GrapeCity_Documents_Word_DocumentBase_">TocFieldOptions(DocumentBase)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.html">TocFieldOptions</a> class.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_TocFieldOptions__ctor_GrapeCity_Documents_Word_SimpleField_" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.#ctor(GrapeCity.Documents.Word.SimpleField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.-ctor.html#GrapeCity_Documents_Word_Fields_TocFieldOptions__ctor_GrapeCity_Documents_Word_SimpleField_">TocFieldOptions(SimpleField)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.html">TocFieldOptions</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_TocFieldOptions_Bookmark" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.Bookmark">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.Bookmark.html#GrapeCity_Documents_Word_Fields_TocFieldOptions_Bookmark">Bookmark</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the name of the bookmark that limits the entries to those within
the portion of the document defined by the bookmark.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_TocFieldOptions_EntryFormatting" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.EntryFormatting">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.EntryFormatting.html#GrapeCity_Documents_Word_Fields_TocFieldOptions_EntryFormatting">EntryFormatting</a>
        </td>
        <td class="markdown level1 summary"><p>Gets options to format TOC entries in the TOC field result.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_TocFieldOptions_FlatList" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.FlatList">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.FlatList.html#GrapeCity_Documents_Word_Fields_TocFieldOptions_FlatList">FlatList</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether the all TOC entries should be on the same level.</p>
<p>Default value is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p> 
<p>If the <a class="xref" href="GrapeCity.Documents.Word.Fields.TocSeqOptions.Collect.html#GrapeCity_Documents_Word_Fields_TocSeqOptions_Collect">Collect</a> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> this property is also <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_TocFieldOptions_PageNumbers" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.PageNumbers">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.PageNumbers.html#GrapeCity_Documents_Word_Fields_TocFieldOptions_PageNumbers">PageNumbers</a>
        </td>
        <td class="markdown level1 summary"><p>Gets options to show page numbers in the TOC field result.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_TocFieldOptions_SeqFields" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.SeqFields">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.SeqFields.html#GrapeCity_Documents_Word_Fields_TocFieldOptions_SeqFields">SeqFields</a>
        </td>
        <td class="markdown level1 summary"><p>Gets options to collect SEQ fields paragraphs by the TOC field.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_TocFieldOptions_Styles" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.Styles">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.Styles.html#GrapeCity_Documents_Word_Fields_TocFieldOptions_Styles">Styles</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the collection of styles of paragraphs which should be collected by the TOC field.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_TocFieldOptions_TcFields" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.TcFields">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.TcFields.html#GrapeCity_Documents_Word_Fields_TocFieldOptions_TcFields">TcFields</a>
        </td>
        <td class="markdown level1 summary"><p>Gets options to collect TC fields by the TOC field.</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_TocFieldOptions_Load_GrapeCity_Documents_Word_ComplexField_" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.Load(GrapeCity.Documents.Word.ComplexField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.Load.html#GrapeCity_Documents_Word_Fields_TocFieldOptions_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_TocFieldOptions_Load_GrapeCity_Documents_Word_SimpleField_" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.Load(GrapeCity.Documents.Word.SimpleField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.Load.html#GrapeCity_Documents_Word_Fields_TocFieldOptions_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_TocFieldOptions_Save_GrapeCity_Documents_Word_ComplexField_" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.Save(GrapeCity.Documents.Word.ComplexField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.Save.html#GrapeCity_Documents_Word_Fields_TocFieldOptions_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_TocFieldOptions_Save_GrapeCity_Documents_Word_SimpleField_" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.Save(GrapeCity.Documents.Word.SimpleField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.Save.html#GrapeCity_Documents_Word_Fields_TocFieldOptions_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_TocFieldOptions_ToString" data-uid="GrapeCity.Documents.Word.Fields.TocFieldOptions.ToString">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.TocFieldOptions.ToString.html#GrapeCity_Documents_Word_Fields_TocFieldOptions_ToString">ToString()</a>
        </td>
        <td class="markdown level1 summary"></td>
      </tr>
    </tbody>
  </table>

</div>