# FarPoint.Win.Spread.IconFilterItem

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="FarPoint_Win_Spread_IconFilterItem" data-uid="FarPoint.Win.Spread.IconFilterItem" class="text-break">IconFilterItem Class
</h1>
  <div class="markdown level0 summary"><p>Provides an IconFilter class to filter cells using an icon specified in the filter 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.Win.Spread.BaseFilterItem.html">BaseFilterItem</a></div>
    <div class="level2"><span class="xref">IconFilterItem</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_IconFilterItem_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class IconFilterItem : BaseFilterItem, ISerializeSupport, ISerializable, ICloneable, IFilterItem</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class IconFilterItem
    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_IconFilterItem__ctor_FarPoint_Win_Spread_ConditionalFormattingIconSetIndex_" data-uid="FarPoint.Win.Spread.IconFilterItem.#ctor(FarPoint.Win.Spread.ConditionalFormattingIconSetIndex)">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.-ctor.html#FarPoint_Win_Spread_IconFilterItem__ctor_FarPoint_Win_Spread_ConditionalFormattingIconSetIndex_">IconFilterItem(ConditionalFormattingIconSetIndex)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.html">IconFilterItem</a> class.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_IconFilterItem__ctor_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_" data-uid="FarPoint.Win.Spread.IconFilterItem.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.-ctor.html#FarPoint_Win_Spread_IconFilterItem__ctor_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_">IconFilterItem(SerializationInfo, StreamingContext)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.html">IconFilterItem</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_IconFilterItem_DisplayAtTopOfList" data-uid="FarPoint.Win.Spread.IconFilterItem.DisplayAtTopOfList">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.DisplayAtTopOfList.html#FarPoint_Win_Spread_IconFilterItem_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_IconFilterItem_DisplayName" data-uid="FarPoint.Win.Spread.IconFilterItem.DisplayName">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.DisplayName.html#FarPoint_Win_Spread_IconFilterItem_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_IconFilterItem_IconSetIndex" data-uid="FarPoint.Win.Spread.IconFilterItem.IconSetIndex">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.IconSetIndex.html#FarPoint_Win_Spread_IconFilterItem_IconSetIndex">IconSetIndex</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the icon used to filter.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_IconFilterItem_IsObjectValueEditable" data-uid="FarPoint.Win.Spread.IconFilterItem.IsObjectValueEditable">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.IsObjectValueEditable.html#FarPoint_Win_Spread_IconFilterItem_IsObjectValueEditable">IsObjectValueEditable</a>
        </td>
        <td class="markdown level1 summary"><p>Gets whether the icon can be edited in the editor.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_IconFilterItem_Label" data-uid="FarPoint.Win.Spread.IconFilterItem.Label">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.Label.html#FarPoint_Win_Spread_IconFilterItem_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_IconFilterItem_ObjectValue" data-uid="FarPoint.Win.Spread.IconFilterItem.ObjectValue">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.ObjectValue.html#FarPoint_Win_Spread_IconFilterItem_ObjectValue">ObjectValue</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the text value for the 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_IconFilterItem_Clone" data-uid="FarPoint.Win.Spread.IconFilterItem.Clone">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.Clone.html#FarPoint_Win_Spread_IconFilterItem_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_IconFilterItem_Deserialize_System_Xml_XmlNodeReader_" data-uid="FarPoint.Win.Spread.IconFilterItem.Deserialize(System.Xml.XmlNodeReader)">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.Deserialize.html#FarPoint_Win_Spread_IconFilterItem_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_IconFilterItem_Equals_System_Object_" data-uid="FarPoint.Win.Spread.IconFilterItem.Equals(System.Object)">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.Equals.html#FarPoint_Win_Spread_IconFilterItem_Equals_System_Object_">Equals(object)</a>
        </td>
        <td class="markdown level1 summary"><p>Determines whether the specified <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a> is equal to this instance.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_IconFilterItem_Filter_System_Int32_" data-uid="FarPoint.Win.Spread.IconFilterItem.Filter(System.Int32)">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.Filter.html#FarPoint_Win_Spread_IconFilterItem_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_IconFilterItem_GetHashCode" data-uid="FarPoint.Win.Spread.IconFilterItem.GetHashCode">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.GetHashCode.html#FarPoint_Win_Spread_IconFilterItem_GetHashCode">GetHashCode()</a>
        </td>
        <td class="markdown level1 summary"><p>Returns a hash code for this instance.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_IconFilterItem_GetObjectData_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_" data-uid="FarPoint.Win.Spread.IconFilterItem.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.GetObjectData.html#FarPoint_Win_Spread_IconFilterItem_GetObjectData_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_">GetObjectData(SerializationInfo, StreamingContext)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the object data.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_IconFilterItem_Serialize_System_Xml_XmlTextWriter_" data-uid="FarPoint.Win.Spread.IconFilterItem.Serialize(System.Xml.XmlTextWriter)">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.Serialize.html#FarPoint_Win_Spread_IconFilterItem_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_IconFilterItem_ShowInDropDown_System_Int32_System_Int32___" data-uid="FarPoint.Win.Spread.IconFilterItem.ShowInDropDown(System.Int32,System.Int32[])">
          <a class="xref" href="FarPoint.Win.Spread.IconFilterItem.ShowInDropDown.html#FarPoint_Win_Spread_IconFilterItem_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>
