# FarPoint.Web.Spread.DefaultFilterItem

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="FarPoint_Web_Spread_DefaultFilterItem" data-uid="FarPoint.Web.Spread.DefaultFilterItem" class="text-break">DefaultFilterItem Class
</h1>
  <div class="markdown level0 summary"><p>Represents the default filtering of rows based on specified criteria.</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="FarPoint.Web.Spread.BaseFilterItem.html">BaseFilterItem</a></div>
    <div class="level2"><span class="xref">DefaultFilterItem</span></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="FarPoint.Web.Spread.Model.ISerializeSupport.html">ISerializeSupport</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.ISortedFilterItem.html">ISortedFilterItem</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.IFilterItem.html">IFilterItem</a></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="FarPoint.Web.Spread.html">FarPoint.Web.Spread</a></h6>
  <h6><strong>Assembly</strong>: FarPoint.Web.Spread.dll</h6>
  <h5 id="FarPoint_Web_Spread_DefaultFilterItem_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class DefaultFilterItem : BaseFilterItem, ISerializeSupport, ISortedFilterItem, IFilterItem</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class DefaultFilterItem
    Inherits BaseFilterItem
    Implements ISerializeSupport, ISortedFilterItem, IFilterItem</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="FarPoint_Web_Spread_DefaultFilterItem__ctor" data-uid="FarPoint.Web.Spread.DefaultFilterItem.#ctor">
          <a class="xref" href="FarPoint.Web.Spread.DefaultFilterItem.-ctor.html#FarPoint_Web_Spread_DefaultFilterItem__ctor">DefaultFilterItem()</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a default filter.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_DefaultFilterItem__ctor_FarPoint_Web_Spread_SheetView_" data-uid="FarPoint.Web.Spread.DefaultFilterItem.#ctor(FarPoint.Web.Spread.SheetView)">
          <a class="xref" href="FarPoint.Web.Spread.DefaultFilterItem.-ctor.html#FarPoint_Web_Spread_DefaultFilterItem__ctor_FarPoint_Web_Spread_SheetView_">DefaultFilterItem(SheetView)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a default filter for the specified sheet.</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="FarPoint_Web_Spread_DefaultFilterItem_DisplayAtTopOfList" data-uid="FarPoint.Web.Spread.DefaultFilterItem.DisplayAtTopOfList">
          <a class="xref" href="FarPoint.Web.Spread.DefaultFilterItem.DisplayAtTopOfList.html#FarPoint_Web_Spread_DefaultFilterItem_DisplayAtTopOfList">DisplayAtTopOfList</a>
        </td>
        <td class="markdown level1 summary"><p>Gets whether the display name should be added to the top of the filter drop-down list.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_DefaultFilterItem_DisplayName" data-uid="FarPoint.Web.Spread.DefaultFilterItem.DisplayName">
          <a class="xref" href="FarPoint.Web.Spread.DefaultFilterItem.DisplayName.html#FarPoint_Web_Spread_DefaultFilterItem_DisplayName">DisplayName</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the display name of the filter.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_DefaultFilterItem_FilterByString" data-uid="FarPoint.Web.Spread.DefaultFilterItem.FilterByString">
          <a class="xref" href="FarPoint.Web.Spread.DefaultFilterItem.FilterByString.html#FarPoint_Web_Spread_DefaultFilterItem_FilterByString">FilterByString</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the string by which to filter.</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="FarPoint_Web_Spread_DefaultFilterItem_BlanksFilterItem_System_Int32_" data-uid="FarPoint.Web.Spread.DefaultFilterItem.BlanksFilterItem(System.Int32)">
          <a class="xref" href="FarPoint.Web.Spread.DefaultFilterItem.BlanksFilterItem.html#FarPoint_Web_Spread_DefaultFilterItem_BlanksFilterItem_System_Int32_">BlanksFilterItem(int)</a>
        </td>
        <td class="markdown level1 summary"><p>Filters item for the specified column to filter in blanks (empty cells).</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_DefaultFilterItem_Deserialize_System_Xml_XmlNodeReader_" data-uid="FarPoint.Web.Spread.DefaultFilterItem.Deserialize(System.Xml.XmlNodeReader)">
          <a class="xref" href="FarPoint.Web.Spread.DefaultFilterItem.Deserialize.html#FarPoint_Web_Spread_DefaultFilterItem_Deserialize_System_Xml_XmlNodeReader_">Deserialize(XmlNodeReader)</a>
        </td>
        <td class="markdown level1 summary"><p>Internal use only. Internal implementation of ISerializeSupport interface method.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_DefaultFilterItem_Filter_System_Int32_" data-uid="FarPoint.Web.Spread.DefaultFilterItem.Filter(System.Int32)">
          <a class="xref" href="FarPoint.Web.Spread.DefaultFilterItem.Filter.html#FarPoint_Web_Spread_DefaultFilterItem_Filter_System_Int32_">Filter(int)</a>
        </td>
        <td class="markdown level1 summary"><p>Filters the specified column of the sheet.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_DefaultFilterItem_NonBlanksFilterItem_System_Int32_" data-uid="FarPoint.Web.Spread.DefaultFilterItem.NonBlanksFilterItem(System.Int32)">
          <a class="xref" href="FarPoint.Web.Spread.DefaultFilterItem.NonBlanksFilterItem.html#FarPoint_Web_Spread_DefaultFilterItem_NonBlanksFilterItem_System_Int32_">NonBlanksFilterItem(int)</a>
        </td>
        <td class="markdown level1 summary"><p>Filters item for the specified column to filter in non-blanks (non-empty cells).</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_DefaultFilterItem_Serialize_System_Xml_XmlTextWriter_" data-uid="FarPoint.Web.Spread.DefaultFilterItem.Serialize(System.Xml.XmlTextWriter)">
          <a class="xref" href="FarPoint.Web.Spread.DefaultFilterItem.Serialize.html#FarPoint_Web_Spread_DefaultFilterItem_Serialize_System_Xml_XmlTextWriter_">Serialize(XmlTextWriter)</a>
        </td>
        <td class="markdown level1 summary"><p>Internal use only. Internal implementation of ISerializeSupport interface method. Saves the object to XML.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_DefaultFilterItem_ShowInDropDown_System_Int32_System_Int32___" data-uid="FarPoint.Web.Spread.DefaultFilterItem.ShowInDropDown(System.Int32,System.Int32[])">
          <a class="xref" href="FarPoint.Web.Spread.DefaultFilterItem.ShowInDropDown.html#FarPoint_Web_Spread_DefaultFilterItem_ShowInDropDown_System_Int32_System_Int32___">ShowInDropDown(int, int[])</a>
        </td>
        <td class="markdown level1 summary"><p>Determines whether the filter item name should be displayed in the filter drop-down list.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>
