# GrapeCity.Documents.Word.Fields.PageRefFieldOptions

## Content

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



  <h1 id="GrapeCity_Documents_Word_Fields_PageRefFieldOptions" data-uid="GrapeCity.Documents.Word.Fields.PageRefFieldOptions" class="text-break">PageRefFieldOptions Class
</h1>
  <div class="markdown level0 summary"><p>Represents PAGEREF field options.</p>
<p>A PAGEREF field inserts the number of the page containing the bookmark for a cross-reference.</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"><a class="xref" href="GrapeCity.Documents.Word.Fields.FieldFormatOptions.html">FieldFormatOptions</a></div>
    <div class="level3"><span class="xref">PageRefFieldOptions</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_PageRefFieldOptions_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class PageRefFieldOptions : FieldFormatOptions, IFieldOptions</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class PageRefFieldOptions
    Inherits FieldFormatOptions
    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_PageRefFieldOptions__ctor_GrapeCity_Documents_Word_ComplexField_" data-uid="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.#ctor(GrapeCity.Documents.Word.ComplexField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.-ctor.html#GrapeCity_Documents_Word_Fields_PageRefFieldOptions__ctor_GrapeCity_Documents_Word_ComplexField_">PageRefFieldOptions(ComplexField)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.html">PageRefFieldOptions</a> class.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_PageRefFieldOptions__ctor_GrapeCity_Documents_Word_DocumentBase_System_String_" data-uid="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.#ctor(GrapeCity.Documents.Word.DocumentBase,System.String)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.-ctor.html#GrapeCity_Documents_Word_Fields_PageRefFieldOptions__ctor_GrapeCity_Documents_Word_DocumentBase_System_String_">PageRefFieldOptions(DocumentBase, string)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.html">PageRefFieldOptions</a> class.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_PageRefFieldOptions__ctor_GrapeCity_Documents_Word_SimpleField_" data-uid="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.#ctor(GrapeCity.Documents.Word.SimpleField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.-ctor.html#GrapeCity_Documents_Word_Fields_PageRefFieldOptions__ctor_GrapeCity_Documents_Word_SimpleField_">PageRefFieldOptions(SimpleField)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.html">PageRefFieldOptions</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_PageRefFieldOptions_Bookmark" data-uid="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.Bookmark">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.Bookmark.html#GrapeCity_Documents_Word_Fields_PageRefFieldOptions_Bookmark">Bookmark</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the bookmark name for a cross-reference.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_PageRefFieldOptions_DisplayRelative" data-uid="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.DisplayRelative">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.DisplayRelative.html#GrapeCity_Documents_Word_Fields_PageRefFieldOptions_DisplayRelative">DisplayRelative</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether to display the position relative to the source bookmark.</p>
<p>Default value is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p> 
<p>If the PAGEREF field is on the same page as the bookmark, it omits "on page #" and returns "above" or "below" only.</p>
<p>If the PAGEREF field is not on the same page as the bookmark, the string "on page #" is used.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Word_Fields_PageRefFieldOptions_Hyperlink" data-uid="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.Hyperlink">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.Hyperlink.html#GrapeCity_Documents_Word_Fields_PageRefFieldOptions_Hyperlink">Hyperlink</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether to create a hyperlink to the bookmarked paragraph.</p>
<p>The 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_PageRefFieldOptions_Save_GrapeCity_Documents_Word_ComplexField_" data-uid="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.Save(GrapeCity.Documents.Word.ComplexField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.Save.html#GrapeCity_Documents_Word_Fields_PageRefFieldOptions_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_PageRefFieldOptions_Save_GrapeCity_Documents_Word_SimpleField_" data-uid="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.Save(GrapeCity.Documents.Word.SimpleField)">
          <a class="xref" href="GrapeCity.Documents.Word.Fields.PageRefFieldOptions.Save.html#GrapeCity_Documents_Word_Fields_PageRefFieldOptions_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>
    </tbody>
  </table>

</div>