C1DataFilter Class

The C1DataFilter lets users filter data based on criteria's. It can be bound to any data-aware control and multiple conditional filtering could be applied.

Inheritance

object

C1DataFilter

Implements

ISupportInitialize

Namespace: C1.Win.DataFilter

Assembly: C1.Win.DataFilter.4.8.dll

Syntax

[ToolboxBitmap(typeof(C1DataFilter), "C1DataFilter.png")]
[ComplexBindingProperties("DataSource", "DataMember")]
public class C1DataFilter : XViewHost, ISupportInitialize

<ToolboxBitmap(GetType(C1DataFilter), "C1DataFilter.png")>
<ComplexBindingProperties("DataSource", "DataMember")>
Public Class C1DataFilter
    Inherits XViewHost
    Implements ISupportInitialize

Constructors

Name	Description
C1DataFilter()	Initializes a new instance of the C1DataFilter control.

Properties

Name	Description
AutoApply	Gets or sets a value indicating whether the filter should be automatically applied to the DataSource when the user changes the filter from the user interface.
AutoGenerateFilters	Gets or sets a value indicating whether to generate filters automatically.
AutoWidthMode	Gets or sets the mode by which the C1DataFilter automatically sets its own width.
BackColor	Gets or sets control back color.
DataMember	Gets or sets a name of a specific record set within the DataSource.
DataSource	Gets or sets the object used as the data source for the current C1DataFilter control.
DefaultSize	Gets the default size of the control.
Filters	Gets the collection of filters.
ForeColor	Do not use this property.
HeaderText	Gets or sets the header text of the current C1DataFilter control.
Margin	Do not use this property.
Padding	Do not use this property.
ShowClearFilterButtons	Gets or sets a value indicating whether to show clear filter buttons in the filter headers or not.
ShowHeader	Gets or sets a value that indicates whether the header is displayed in the C1DataFilter control.
ShowToolTips	Gets or sets whether the C1DataFilter should display tooltips.
Styles	Gets DataFilterTheme C1DataFilter styles.
View	Gets the result of filtering the DataSource.

Methods

Name	Description
ApplyFilter()	Applies the filter to the items source.
ApplyFilterAsync()	Applies the filter to the items source asynchronously.
BeginInit()
CollapseAll()	Collapses all filters in the C1DataFilter control.
Dispose(bool)	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
EndInit()
ExpandAll()	Expands all filters in the C1DataFilter control.
GenerateFilters(bool)	Generates filters for the current items source.
GetFilterExpression()	Returns the current value of the filters that can be applied.
GetPreferredSize(Size)	Retrieves the size of a rectangular area into which a control can be fitted.
LoadFilterExpression(string)	Loads expressions to the Filters collection from a file.
OnBeforeTooltipShow(BeforeTooltipShowEventArgs)	Rises the BeforeTooltipShow event.
OnFilterAutoGenerating(FilterAutoGeneratingEventArgs)	Raises the FilterAutoGenerating event.
OnFilterChanged(EventArgs)	Raises the FilterChanged event.
OnFilterChanging(CancelEventArgs)	Raises the FilterChanging event.
OnFilterValueChanged(FilterChangedEventArgs)	Raises the FilterValueChanged event.
OnRightToLeftChanged(EventArgs)	Raises the RightToLeftChanged event.
ResetFilters()
ResetStyles()
SaveFilterExpression(string)	Saves expressions from the Filters collection to a file.
ShouldSerializeFilters()
ShouldSerializeStyles()

Events

Name	Description
BeforeTooltipShow	Occurs before a tooltip is shown.
FilterAutoGenerating	Occurs before the filter is added to the Filters. Allows to cancel the change.
FilterChanged	Occurs when the filter changes.
FilterChanging	Occurs before the filter is changed. Allows to cancel the change.
FilterValueChanged	Occurs when a value of the filter changes.