# C1.WPF.FlexGrid.C1FlexGridFilter

## Content

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



  <h1 id="C1_WPF_FlexGrid_C1FlexGridFilter" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter" class="text-break">C1FlexGridFilter Class
</h1>
  <div class="markdown level0 summary"><p>Implements an Excel-style filter that can be added to existing C1FlexGrid controls.</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">C1FlexGridFilter</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="C1.WPF.FlexGrid.html">C1.WPF.FlexGrid</a></h6>
  <h6><strong>Assembly</strong>: C1.WPF.FlexGridFilter.4.6.2.dll</h6>
  <h5 id="C1_WPF_FlexGrid_C1FlexGridFilter_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class C1FlexGridFilter</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class C1FlexGridFilter</code></pre>
  </div>
  <h5 id="C1_WPF_FlexGrid_C1FlexGridFilter_remarks"><strong>Remarks</strong></h5>
  <div class="markdown level0 remarks"><p>To enable filtering on a C1FlexGrid control, create an instance of a C1FlexGridFilter
and pass the grid as a parameter to the constructor. For example:</p>
<pre><code class="lang-csharp">// enable filtering on the _flex control
var ff = new C1FlexGridFilter(_flex);</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="C1_WPF_FlexGrid_C1FlexGridFilter__ctor" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.#ctor">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.-ctor.html#C1_WPF_FlexGrid_C1FlexGridFilter__ctor">C1FlexGridFilter()</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of a <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.html">C1FlexGridFilter</a>.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter__ctor_C1_WPF_FlexGrid_C1FlexGrid_" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.#ctor(C1.WPF.FlexGrid.C1FlexGrid)">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.-ctor.html#C1_WPF_FlexGrid_C1FlexGridFilter__ctor_C1_WPF_FlexGrid_C1FlexGrid_">C1FlexGridFilter(C1FlexGrid)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of a <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.html">C1FlexGridFilter</a>.</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="C1_WPF_FlexGrid_C1FlexGridFilter_Editor" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.Editor">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.Editor.html#C1_WPF_FlexGrid_C1FlexGridFilter_Editor">Editor</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.windows.controls.control">Control</a> used to edit the filter parameters.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_FilterDefinition" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.FilterDefinition">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.FilterDefinition.html#C1_WPF_FlexGrid_C1FlexGridFilter_FilterDefinition">FilterDefinition</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the current filter definition as an XML string.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_NullValueString" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.NullValueString">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.NullValueString.html#C1_WPF_FlexGrid_C1FlexGridFilter_NullValueString">NullValueString</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the string that represents null values in the value list.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_Owner" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.Owner">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.Owner.html#C1_WPF_FlexGrid_C1FlexGridFilter_Owner">Owner</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the <a class="xref" href="../C1.WPF.FlexGrid.4.6.2/C1.WPF.FlexGrid.C1FlexGrid.html">C1FlexGrid</a> that owns this filter.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_UseCollectionView" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.UseCollectionView">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.UseCollectionView.html#C1_WPF_FlexGrid_C1FlexGridFilter_UseCollectionView">UseCollectionView</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether the filter should be applied to the grid's data source.</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="C1_WPF_FlexGrid_C1FlexGridFilter_Apply" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.Apply">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.Apply.html#C1_WPF_FlexGrid_C1FlexGridFilter_Apply">Apply()</a>
        </td>
        <td class="markdown level1 summary"><p>Applies the current filters to the rows currently loaded on the grid.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_Clear" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.Clear">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.Clear.html#C1_WPF_FlexGrid_C1FlexGridFilter_Clear">Clear()</a>
        </td>
        <td class="markdown level1 summary"><p>Clears all column filters in this <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.html">C1FlexGridFilter</a>.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_GetColumnFilter_C1_WPF_FlexGrid_Column_" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.GetColumnFilter(C1.WPF.FlexGrid.Column)">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.GetColumnFilter.html#C1_WPF_FlexGrid_C1FlexGridFilter_GetColumnFilter_C1_WPF_FlexGrid_Column_">GetColumnFilter(Column)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the filter attached to a given grid column.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_LoadFilterDefinition_System_Xml_XmlReader_" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.LoadFilterDefinition(System.Xml.XmlReader)">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.LoadFilterDefinition.html#C1_WPF_FlexGrid_C1FlexGridFilter_LoadFilterDefinition_System_Xml_XmlReader_">LoadFilterDefinition(XmlReader)</a>
        </td>
        <td class="markdown level1 summary"><p>Loads a filter definition from an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.xmlreader">XmlReader</a>.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_OnEditorClosed_System_EventArgs_" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.OnEditorClosed(System.EventArgs)">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.OnEditorClosed.html#C1_WPF_FlexGrid_C1FlexGridFilter_OnEditorClosed_System_EventArgs_">OnEditorClosed(EventArgs)</a>
        </td>
        <td class="markdown level1 summary"><p>Raises the <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.EditorClosed.html">EditorClosed</a> event.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_OnEditorOpened_System_EventArgs_" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.OnEditorOpened(System.EventArgs)">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.OnEditorOpened.html#C1_WPF_FlexGrid_C1FlexGridFilter_OnEditorOpened_System_EventArgs_">OnEditorOpened(EventArgs)</a>
        </td>
        <td class="markdown level1 summary"><p>Raises the <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.EditorOpened.html">EditorOpened</a> event.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_OnFilterApplied_System_EventArgs_" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.OnFilterApplied(System.EventArgs)">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.OnFilterApplied.html#C1_WPF_FlexGrid_C1FlexGridFilter_OnFilterApplied_System_EventArgs_">OnFilterApplied(EventArgs)</a>
        </td>
        <td class="markdown level1 summary"><p>Raises the <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.FilterApplied.html">FilterApplied</a> event.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_OnFilterChanged_System_EventArgs_" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.OnFilterChanged(System.EventArgs)">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.OnFilterChanged.html#C1_WPF_FlexGrid_C1FlexGridFilter_OnFilterChanged_System_EventArgs_">OnFilterChanged(EventArgs)</a>
        </td>
        <td class="markdown level1 summary"><p>Raises the FilterChanged event.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_SaveFilterDefinition_System_Xml_XmlWriter_" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.SaveFilterDefinition(System.Xml.XmlWriter)">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.SaveFilterDefinition.html#C1_WPF_FlexGrid_C1FlexGridFilter_SaveFilterDefinition_System_Xml_XmlWriter_">SaveFilterDefinition(XmlWriter)</a>
        </td>
        <td class="markdown level1 summary"><p>Save the current filter definition to an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.xmlwriter">XmlWriter</a>.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_ShowFilterEditor_C1_WPF_FlexGrid_Column_" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.ShowFilterEditor(C1.WPF.FlexGrid.Column)">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.ShowFilterEditor.html#C1_WPF_FlexGrid_C1FlexGridFilter_ShowFilterEditor_C1_WPF_FlexGrid_Column_">ShowFilterEditor(Column)</a>
        </td>
        <td class="markdown level1 summary"><p>Show the filter editor for a given grid column.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="events">Events
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_EditorClosed" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.EditorClosed">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.EditorClosed.html">EditorClosed</a>
        </td>
        <td class="markdown level1 summary"><p>Occurs when the filter editor is closed.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_EditorOpened" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.EditorOpened">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.EditorOpened.html">EditorOpened</a>
        </td>
        <td class="markdown level1 summary"><p>Occurs when the filter editor is displayed.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_FlexGrid_C1FlexGridFilter_FilterApplied" data-uid="C1.WPF.FlexGrid.C1FlexGridFilter.FilterApplied">
          <a class="xref" href="C1.WPF.FlexGrid.C1FlexGridFilter.FilterApplied.html">FilterApplied</a>
        </td>
        <td class="markdown level1 summary"><p>Occurs when the filter is applied to the grid.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>