# GrapeCity.Documents.Excel.PivotFilterOptions

## Content

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



  <h1 id="GrapeCity_Documents_Excel_PivotFilterOptions" data-uid="GrapeCity.Documents.Excel.PivotFilterOptions" class="text-break">PivotFilterOptions Class
</h1>
  <div class="markdown level0 summary"><p>Represents optional settings for pivot filters, containing special settings for value filters, date filters, and top 10 filters.</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">PivotFilterOptions</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="GrapeCity.Documents.Excel.html">GrapeCity.Documents.Excel</a></h6>
  <h6><strong>Assembly</strong>: DS.Documents.Excel.dll</h6>
  <h5 id="GrapeCity_Documents_Excel_PivotFilterOptions_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class PivotFilterOptions</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class PivotFilterOptions</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_Excel_PivotFilterOptions__ctor" data-uid="GrapeCity.Documents.Excel.PivotFilterOptions.#ctor">
          <a class="xref" href="GrapeCity.Documents.Excel.PivotFilterOptions.-ctor.html#GrapeCity_Documents_Excel_PivotFilterOptions__ctor">PivotFilterOptions()</a>
        </td>
        <td class="markdown level1 summary"></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_Excel_PivotFilterOptions_AppliedDataField" data-uid="GrapeCity.Documents.Excel.PivotFilterOptions.AppliedDataField">
          <a class="xref" href="GrapeCity.Documents.Excel.PivotFilterOptions.AppliedDataField.html#GrapeCity_Documents_Excel_PivotFilterOptions_AppliedDataField">AppliedDataField</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the value filter setting. Specifies which DataField the current field is filtered by.
The value represents the index of the referenced DataField in the <a class="xref" href="GrapeCity.Documents.Excel.IPivotTable.DataFields.html#GrapeCity_Documents_Excel_IPivotTable_DataFields">DataFields</a> collection.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_PivotFilterOptions_Description" data-uid="GrapeCity.Documents.Excel.PivotFilterOptions.Description">
          <a class="xref" href="GrapeCity.Documents.Excel.PivotFilterOptions.Description.html#GrapeCity_Documents_Excel_PivotFilterOptions_Description">Description</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a brief description of the filter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_PivotFilterOptions_IsTop10Type" data-uid="GrapeCity.Documents.Excel.PivotFilterOptions.IsTop10Type">
          <a class="xref" href="GrapeCity.Documents.Excel.PivotFilterOptions.IsTop10Type.html#GrapeCity_Documents_Excel_PivotFilterOptions_IsTop10Type">IsTop10Type</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating the selection direction of the 'top 10 filter'.
'True' means selecting the top n items, and 'false' means selecting the bottom n items.
The default value is 'true'.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_PivotFilterOptions_Name" data-uid="GrapeCity.Documents.Excel.PivotFilterOptions.Name">
          <a class="xref" href="GrapeCity.Documents.Excel.PivotFilterOptions.Name.html#GrapeCity_Documents_Excel_PivotFilterOptions_Name">Name</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the name of the filter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_PivotFilterOptions_WholeDayFilter" data-uid="GrapeCity.Documents.Excel.PivotFilterOptions.WholeDayFilter">
          <a class="xref" href="GrapeCity.Documents.Excel.PivotFilterOptions.WholeDayFilter.html#GrapeCity_Documents_Excel_PivotFilterOptions_WholeDayFilter">WholeDayFilter</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether the date filter should use whole days in its filtering criteria.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>