C1FilterEditor Class

The C1FilterEditor represents a filter as a condition tree.

Inheritance

C1FilterEditor

Namespace: C1.Win.DataFilter

Assembly: C1.Win.DataFilter.10.dll

Syntax

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

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

Constructors

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

Properties

Name	Description
AllowDrop
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 C1FilterEditor control.
DefaultSize	Gets the default size of the control.
EnableDragDrop	Gets or sets a value indicating whether a drag and drop should be enable or not.
ForeColor	Do not use this property.
Margin	Do not use this property.
NestedPropertiesVisibility	Gets or sets a value indicating whether to display nested properties in the property list.
Padding	Do not use this property.
Styles	Gets FilterEditorTheme C1FilterEditor styles.
View	Gets the result of filtering the DataSource.

Methods

Name	Description
ApplyFilterAsync()	Applies the filter to the data source asynchronously.
ClearFilter()	Removes all expressions from filter.
Dispose(bool)	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
GetExpression()	Gets the condition expression for the filter.
GetFilterExpression()	Returns the current value of the filters that can be applied.
OnCustomEditorInitializing(CustomEditorEventArgs)	Raises the CustomEditorInitializing event.
OnFilterChanged(EventArgs)	Raises the FilterChanged event.
OnFilterChanging(CancelEventArgs)	Raises the FilterChanging event.
OnListingProperty(ListingPropertyEventArgs)	Raises the ListingProperty event.
ResetStyles()
SetExpression(Expression)	Sets the condition expression for the filter.
ShouldSerializeStyles()

Events

Name	Description
CustomEditorInitializing	Occurs before the editor is initialized.
FilterChanged	Occurs when the filter changes.
FilterChanging	Occurs before the filter is changed. Allows to cancel the change.
ListingProperty	Occurs before a property is added to the drop-down property list.