# FarPoint.Win.Spread.CustomFilterItem

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="FarPoint_Win_Spread_CustomFilterItem" data-uid="FarPoint.Win.Spread.CustomFilterItem" class="text-break">CustomFilterItem Class
</h1>
  <div class="markdown level0 summary"><p>Provides a CustomFilters class that groups custom filter elements together.</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.Win.Spread.BaseFilterItem.html">BaseFilterItem</a></div>
    <div class="level2"><span class="xref">CustomFilterItem</span></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="../FarPoint.Win/FarPoint.Win.ISerializeSupport.html">ISerializeSupport</a></div>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.serialization.iserializable">ISerializable</a></div>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.icloneable">ICloneable</a></div>
    <div><a class="xref" href="FarPoint.Win.Spread.IFilterItem.html">IFilterItem</a></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="FarPoint.Win.Spread.html">FarPoint.Win.Spread</a></h6>
  <h6><strong>Assembly</strong>: FarPoint.Win.Spread.dll</h6>
  <h5 id="FarPoint_Win_Spread_CustomFilterItem_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class CustomFilterItem : BaseFilterItem, ISerializeSupport, ISerializable, ICloneable, IFilterItem</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class CustomFilterItem
    Inherits BaseFilterItem
    Implements ISerializeSupport, ISerializable, ICloneable, 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_Win_Spread_CustomFilterItem__ctor_FarPoint_Win_Spread_FilterCondition_FarPoint_Win_Spread_FilterCondition_System_Boolean_" data-uid="FarPoint.Win.Spread.CustomFilterItem.#ctor(FarPoint.Win.Spread.FilterCondition,FarPoint.Win.Spread.FilterCondition,System.Boolean)">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.-ctor.html#FarPoint_Win_Spread_CustomFilterItem__ctor_FarPoint_Win_Spread_FilterCondition_FarPoint_Win_Spread_FilterCondition_System_Boolean_">CustomFilterItem(FilterCondition, FilterCondition, bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates an instance of custom filters.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem__ctor_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_" data-uid="FarPoint.Win.Spread.CustomFilterItem.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.-ctor.html#FarPoint_Win_Spread_CustomFilterItem__ctor_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_">CustomFilterItem(SerializationInfo, StreamingContext)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.html">CustomFilterItem</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="FarPoint_Win_Spread_CustomFilterItem_And" data-uid="FarPoint.Win.Spread.CustomFilterItem.And">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.And.html#FarPoint_Win_Spread_CustomFilterItem_And">And</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the And relationship.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_DisplayAtTopOfList" data-uid="FarPoint.Win.Spread.CustomFilterItem.DisplayAtTopOfList">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.DisplayAtTopOfList.html#FarPoint_Win_Spread_CustomFilterItem_DisplayAtTopOfList">DisplayAtTopOfList</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether the display name is added to the top of the filter drop-down list.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_DisplayName" data-uid="FarPoint.Win.Spread.CustomFilterItem.DisplayName">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.DisplayName.html#FarPoint_Win_Spread_CustomFilterItem_DisplayName">DisplayName</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the display name of the filter.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_FirstCondition" data-uid="FarPoint.Win.Spread.CustomFilterItem.FirstCondition">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.FirstCondition.html#FarPoint_Win_Spread_CustomFilterItem_FirstCondition">FirstCondition</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the first custom filter.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_IsObjectValueEditable" data-uid="FarPoint.Win.Spread.CustomFilterItem.IsObjectValueEditable">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.IsObjectValueEditable.html#FarPoint_Win_Spread_CustomFilterItem_IsObjectValueEditable">IsObjectValueEditable</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether the object value can be edited.
In the filter bar UI, the text editor is displayed if the value is true.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_Label" data-uid="FarPoint.Win.Spread.CustomFilterItem.Label">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.Label.html#FarPoint_Win_Spread_CustomFilterItem_Label">Label</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the displayed text of the filter (filter name or operator).</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_ObjectValue" data-uid="FarPoint.Win.Spread.CustomFilterItem.ObjectValue">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.ObjectValue.html#FarPoint_Win_Spread_CustomFilterItem_ObjectValue">ObjectValue</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the text value for the filter.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_SecondCondition" data-uid="FarPoint.Win.Spread.CustomFilterItem.SecondCondition">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.SecondCondition.html#FarPoint_Win_Spread_CustomFilterItem_SecondCondition">SecondCondition</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the second custom 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_Win_Spread_CustomFilterItem_Clone" data-uid="FarPoint.Win.Spread.CustomFilterItem.Clone">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.Clone.html#FarPoint_Win_Spread_CustomFilterItem_Clone">Clone()</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new object that is a copy of the current instance.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_Deserialize_System_Xml_XmlNodeReader_" data-uid="FarPoint.Win.Spread.CustomFilterItem.Deserialize(System.Xml.XmlNodeReader)">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.Deserialize.html#FarPoint_Win_Spread_CustomFilterItem_Deserialize_System_Xml_XmlNodeReader_">Deserialize(XmlNodeReader)</a>
        </td>
        <td class="markdown level1 summary"><p>Loads the object from XML.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_Equals_System_Object_" data-uid="FarPoint.Win.Spread.CustomFilterItem.Equals(System.Object)">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.Equals.html#FarPoint_Win_Spread_CustomFilterItem_Equals_System_Object_">Equals(object)</a>
        </td>
        <td class="markdown level1 summary"><p>Determines whether the specified System.Object is equal to the current CustomFilter object.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_Filter_System_Int32_" data-uid="FarPoint.Win.Spread.CustomFilterItem.Filter(System.Int32)">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.Filter.html#FarPoint_Win_Spread_CustomFilterItem_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_Win_Spread_CustomFilterItem_GetHashCode" data-uid="FarPoint.Win.Spread.CustomFilterItem.GetHashCode">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.GetHashCode.html#FarPoint_Win_Spread_CustomFilterItem_GetHashCode">GetHashCode()</a>
        </td>
        <td class="markdown level1 summary"><p>Serves as a hash function for <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.html">CustomFilterItem</a> class.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_GetObjectData_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_" data-uid="FarPoint.Win.Spread.CustomFilterItem.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.GetObjectData.html#FarPoint_Win_Spread_CustomFilterItem_GetObjectData_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_">GetObjectData(SerializationInfo, StreamingContext)</a>
        </td>
        <td class="markdown level1 summary"><p>Populates a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.serialization.serializationinfo">SerializationInfo</a> with the data needed to serialize the target object.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_Serialize_System_Xml_XmlTextWriter_" data-uid="FarPoint.Win.Spread.CustomFilterItem.Serialize(System.Xml.XmlTextWriter)">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.Serialize.html#FarPoint_Win_Spread_CustomFilterItem_Serialize_System_Xml_XmlTextWriter_">Serialize(XmlTextWriter)</a>
        </td>
        <td class="markdown level1 summary"><p>Saves the object to XML.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_CustomFilterItem_ShowInDropDown_System_Int32_System_Int32___" data-uid="FarPoint.Win.Spread.CustomFilterItem.ShowInDropDown(System.Int32,System.Int32[])">
          <a class="xref" href="FarPoint.Win.Spread.CustomFilterItem.ShowInDropDown.html#FarPoint_Win_Spread_CustomFilterItem_ShowInDropDown_System_Int32_System_Int32___">ShowInDropDown(int, int[])</a>
        </td>
        <td class="markdown level1 summary"><p>Determines whether the name is displayed in the filter drop-down list.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>
