# GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions" data-uid="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions" class="text-break">PivotFieldNumberGroupOptions Class
</h1>
  <div class="markdown level0 summary"><p>Represents the settings used to group a PivotField into numeric ranges.</p>
<p>
Use this class to configure the numeric range and interval used by
<a class="xref" href="GrapeCity.Documents.Excel.IPivotField.Group.html#GrapeCity_Documents_Excel_IPivotField_Group_GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_">Group(PivotFieldNumberGroupOptions)</a>.
By default, the group range is determined from the PivotCache and the interval is 1.
</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">PivotFieldNumberGroupOptions</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_PivotFieldNumberGroupOptions_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class PivotFieldNumberGroupOptions</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class PivotFieldNumberGroupOptions</code></pre>
  </div>
  <h5 id="GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_examples"><strong>Examples</strong></h5>
  <pre><code class="lang-csharp">PivotFieldNumberGroupOptions options = new PivotFieldNumberGroupOptions
{
    Start = 10348,
    End = 10407,
    AutoStart = false,
    AutoEnd = false,
    Interval = 20
};
orderIdField.Group(options);</code></pre>

  <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_PivotFieldNumberGroupOptions__ctor" data-uid="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.#ctor">
          <a class="xref" href="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.-ctor.html#GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions__ctor">PivotFieldNumberGroupOptions()</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_PivotFieldNumberGroupOptions_AutoEnd" data-uid="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.AutoEnd">
          <a class="xref" href="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.AutoEnd.html#GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_AutoEnd">AutoEnd</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether the last number is determined from the PivotCache instead of <a class="xref" href="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.End.html#GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_End">End</a>.
When this value is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>, <a class="xref" href="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.End.html#GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_End">End</a> must be set when grouping is applied.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_AutoStart" data-uid="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.AutoStart">
          <a class="xref" href="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.AutoStart.html#GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_AutoStart">AutoStart</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether the first number is determined from the PivotCache instead of <a class="xref" href="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.Start.html#GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_Start">Start</a>.
When this value is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>, <a class="xref" href="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.Start.html#GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_Start">Start</a> must be set when grouping is applied.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_End" data-uid="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.End">
          <a class="xref" href="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.End.html#GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_End">End</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the ending number used to derive the grouped range.</p>
<p>
Generated buckets are left-closed and right-open. When <a class="xref" href="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.AutoEnd.html#GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_AutoEnd">AutoEnd</a> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>, this value is ignored and the last number is determined from the PivotCache.
</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_Interval" data-uid="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.Interval">
          <a class="xref" href="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.Interval.html#GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_Interval">Interval</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the numeric interval used to create each generated group.</p>
<p>
The interval must be greater than 0 and finite when grouping is applied.
The effective start value must also be less than the effective end value.
The default value is 1.
</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_Start" data-uid="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.Start">
          <a class="xref" href="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.Start.html#GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_Start">Start</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the first number included in the grouped range.</p>
<p>
When <a class="xref" href="GrapeCity.Documents.Excel.PivotFieldNumberGroupOptions.AutoStart.html#GrapeCity_Documents_Excel_PivotFieldNumberGroupOptions_AutoStart">AutoStart</a> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a>, this value is ignored and the first number is determined from the PivotCache.
</p>
</td>
      </tr>
    </tbody>
  </table>

</div>
