# GrapeCity.Documents.Word.Fields.XeFieldOptions

## Content

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



  <h1 id="GrapeCity_Documents_Word_Fields_XeFieldOptions" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions" class="text-break">XeFieldOptions Class
</h1>
  <div class="markdown level0 summary"><p>Represents XE field options.</p>
<p>The XE field defines options used for entires in an INDEX field (see <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.html">IndexFieldOptions</a>).</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">XeFieldOptions</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_XeFieldOptions_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class XeFieldOptions : BaseFieldOptions, IFieldOptions</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class XeFieldOptions
    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_XeFieldOptions__ctor_GrapeCity_Documents_Word_ComplexField_" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.#ctor(GrapeCity.Documents.Word.ComplexField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.-ctor.html#GrapeCity_Documents_Word_Fields_XeFieldOptions__ctor_GrapeCity_Documents_Word_ComplexField_">XeFieldOptions(ComplexField)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.html">XeFieldOptions</a> class.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_XeFieldOptions__ctor_GrapeCity_Documents_Word_DocumentBase_" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.#ctor(GrapeCity.Documents.Word.DocumentBase)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.-ctor.html#GrapeCity_Documents_Word_Fields_XeFieldOptions__ctor_GrapeCity_Documents_Word_DocumentBase_">XeFieldOptions(DocumentBase)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.html">XeFieldOptions</a> class.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_XeFieldOptions__ctor_GrapeCity_Documents_Word_SimpleField_" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.#ctor(GrapeCity.Documents.Word.SimpleField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.-ctor.html#GrapeCity_Documents_Word_Fields_XeFieldOptions__ctor_GrapeCity_Documents_Word_SimpleField_">XeFieldOptions(SimpleField)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.html">XeFieldOptions</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_XeFieldOptions_Behavior" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.Behavior">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Behavior.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_Behavior">Behavior</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the field behavior.</p>
<p>Default value is <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldBehavior.html#GrapeCity_Documents_Word_Fields_XeFieldBehavior_Page">Page</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_XeFieldOptions_Bold" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.Bold">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Bold.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_Bold">Bold</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether to apply bold formatting to the entry's page number.</p>
<p>However, if the index style for that entry is already bold, the <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> value removes that formatting for that entry.</p> 
<p>This property does not have effect if the <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Behavior.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_Behavior">Behavior</a> property is <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldBehavior.html#GrapeCity_Documents_Word_Fields_XeFieldBehavior_CrossReference">CrossReference</a>.</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_XeFieldOptions_Entry" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.Entry">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Entry.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_Entry">Entry</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the index entry.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_XeFieldOptions_Italic" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.Italic">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Italic.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_Italic">Italic</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether to apply italic formatting to the entry's page number.</p>
<p>However, if the index style for that entry is already italic, the <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> removes that formatting for that entry.</p> 
<p>This property does not have effect if the <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Behavior.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_Behavior">Behavior</a> property is <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldBehavior.html#GrapeCity_Documents_Word_Fields_XeFieldBehavior_CrossReference">CrossReference</a>.</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_XeFieldOptions_PageRangeBookmark" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.PageRangeBookmark">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.PageRangeBookmark.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_PageRangeBookmark">PageRangeBookmark</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the name of the bookmark which is used as the range of pages marked by the bookmark instead of the page number.</p>
<p>This property has effect only if <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Behavior.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_Behavior">Behavior</a> is <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldBehavior.html#GrapeCity_Documents_Word_Fields_XeFieldBehavior_PageRange">PageRange</a>.</p>
<p>Default value is <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string.empty">Empty</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_XeFieldOptions_Reference" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.Reference">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Reference.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_Reference">Reference</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the formatted content which is used in place of a page number.</p>
<p>This property has effect only if <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Behavior.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_Behavior">Behavior</a> is <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldBehavior.html#GrapeCity_Documents_Word_Fields_XeFieldBehavior_CrossReference">CrossReference</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_XeFieldOptions_Type" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.Type">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Type.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_Type">Type</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the type of the entry.
Provides a way to associate the entry with a specific index,
see <a class="xref" href="GrapeCity.Documents.Word.Fields.IndexFieldOptions.EntriesType.html#GrapeCity_Documents_Word_Fields_IndexFieldOptions_EntriesType">EntriesType</a> for details.</p>
<p>Default value is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</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_XeFieldOptions_Load_GrapeCity_Documents_Word_ComplexField_" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.Load(GrapeCity.Documents.Word.ComplexField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Load.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_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_XeFieldOptions_Load_GrapeCity_Documents_Word_SimpleField_" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.Load(GrapeCity.Documents.Word.SimpleField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Load.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_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_XeFieldOptions_Save_GrapeCity_Documents_Word_ComplexField_" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.Save(GrapeCity.Documents.Word.ComplexField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Save.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_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_XeFieldOptions_Save_GrapeCity_Documents_Word_SimpleField_" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.Save(GrapeCity.Documents.Word.SimpleField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.Save.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_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_XeFieldOptions_ToString" data-uid="GrapeCity.Documents.Word.Fields.XeFieldOptions.ToString">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.XeFieldOptions.ToString.html#GrapeCity_Documents_Word_Fields_XeFieldOptions_ToString">ToString()</a>
        </td>
        <td class="markdown level1 summary"></td>
      </tr>
    </tbody>
  </table>

</div>