C1FullTextFilter Class

Implements a full text filter that can be added to existing C1FlexGrid controls.

Inheritance

object

DispatcherObject

DependencyObject

C1FullTextFilter

Namespace: C1.WPF.FlexGrid

Assembly: C1.WPF.FlexGridFilter.4.6.2.dll

Syntax

public class C1FullTextFilter : DependencyObject

Public Class C1FullTextFilter
    Inherits DependencyObject

Remarks

To enable filtering on a C1FlexGrid control, create an instance of a C1FullTextFilter and pass the grid as a parameter to the constructor. For example:

// enable filtering on the _flex control
var ff = new C1FullTextFilter(_flex);

Constructors

Name	Description
C1FullTextFilter()	Initializes a new instance of the C1FullTextFilter class.
C1FullTextFilter(C1FlexGrid)	Initializes a new instance of the C1FullTextFilter class.

Fields

Name	Description
FilterEntryProperty	Gets or sets the Entry field used to perform the query.
HighlightedBackgroundProperty	Gets or sets the brush used to highlight the cell background that matches the searched text.
HighlightedForegroundProperty	Gets or sets the brush used to highlight the cell foreground that matches the searched text.
MatchCaseProperty	Gets or sets whether the filtered text should match the whole word.
MatchNumbersProperty	Gets or sets whether number columns should be taken into account.
MatchWholeWordProperty	Gets or sets whether the filtered text should match the whole word.
ModeProperty	Specifies whether the spaces act as "AND" operator or the query should be matched as it is, including spaces.
TextChangedDelayProperty	Gets or sets the delay time used to filter after the last typed character.
TreatSpacesAsAndOperatorProperty	Specifies whether the spaces act as "AND" operator or the query should be matched as it is, including spaces.

Properties

Name	Description
Delay	Gets or sets the delay time used to filter after the last typed character.
FilterEntry	Gets or sets the Entry field used to perform the query.
HighlightedBackground	Gets or sets the brush used to highlight the cell background that matches the searched text.
HighlightedForeground	Gets or sets the brush used to highlight the cell foreground that matches the searched text.
MatchCase	Gets or sets whether the filtered text should match the case too.
MatchNumbers	Gets or sets whether number columns should be taken into account.
MatchWholeWord	Gets or sets whether the filtered text should match the whole word.
Mode	Gets or sets the mode the filter will be performed.
NullValueString
Owner	Gets or sets the C1FlexGrid that owns this filter.
TreatSpacesAsAndOperator	Specifies whether the spaces act as "AND" operator or the query should be matched as it is, including spaces.
UseCollectionView	Gets or sets whether the filter should be applied to the grid's data source.

Methods

Name	Description
Apply()	Applies the current filters to the rows currently loaded on the grid.
OnFilterApplied(EventArgs)	Raises the FilterApplied event.
OnFilterChanged(EventArgs)	Raises the FilterChanged event.

Events

Name	Description
FilterApplied	Occurs when the filter is applied to the grid.